May 2023

'Mayeth' this not be a shock to you: we've got some pretty cool updates!

Aggregation

🎉 New

New sandbox environment institution: Employment records! 🚀

We have launched our employment data to our sandbox environment, so you can now play with employment data in all our three environments:

  • sandbox: planet_mx_employment
  • development: imss_mx_employment
  • production: imss_mx_employment

Here you’ll find all the info about our new sandbox institutionplanet_mx_employment that will allow you to test employment records with dummy data all you want.

For more info on Employment Records, check our API Reference. And, if this is your first time using our sandbox, you can use our Get started article to get you all set up in less than 10 minutes.

New parameter on link creation: fetch_resources

Our new fetch_resources parameter allows you to get historical update webhooks for your single links! This can significantly improve your data flow as previously, with single links, you would need to make separate POST calls to retrieve the data about the user.

Now, for each resource you list, we'll automatically retrieve the historical data for you and notify you via webhook when the data is ready. Check out the example below:

{
  "access_mode": "recurrent",
  "institution": "erebor_mx_retail",
  "username": "bnk100",
  "password": "full",
  "fetch_historical": true, // must be set to true
  "fetch_resources": [ // For each of the resources listed, we'll notify you via webhook when data is available
    "ACCOUNTS",
    "OWNERS",
    "TRANSACTIONS"
  ]
}

For more information, check out our Register Link request in our API reference.

fetch_resource excerpt in our API reference

fetch_resource excerpt in our API reference

💪 Improved

New and improved institution screen in the widget

We've updated the look and feel of the institution list and search within our widget. With this update, users will:

  • always have access to the search bar.
  • see a larger amount of institutions at first glance.
  • have one step less when looking for their institution.
New institution screen in the widget

New institution screen in the widget

⚠️ Deprecated

Removed read_links from the required scopes for widget token creation

We removed the need to add the read_links scope when creating an access token to launch the widget. We've made improvements in the backend to automate this process for you.

Enrichment

💪 Improved

Incomes examples now “add up” 🤓

We decided to improve our Incomes example and provide you with one that’s semantically correct. You can check our Incomes resource here.

But that’s not all! We’ve also updated our EYOD Income verification example to match Incomes too. We love consistency! Check your API Reference for more info.

🐞 Fixed

EYOD Income Verification missing description

In our Incomes and EYOD Income Verification resources, the allowed_income_types request parameter had no description.

Payment Initiation

💪 Improved

Register individual bank accounts for your customers (🇧🇷 OFPI)

We’ve updated our OFPI guides with info on how to create individual bank accounts for your customers. Here are the new payload examples you can follow to create bank accounts:

{
  "customer_type": "INDIVIDUAL",
  "identifier": "00000000001",
  "identifier_type": "CPF",
  "name": "Caetano Veloso",
  "country": "BRA",
  "email": "[email protected]",
}
{
  "id": "49f244ef-06cd-49cf-ad0c-f43796e370ad",
  "created_at": "2020-04-23T21:30:20.336854+00:00",
  "created_by": "1c83ead8-6665-429c-a17a-ddc76cb3a95e",
  "customer_type": "INDIVIDUAL",
  "name": "Caetano Veloso",
  "country": "BRA",
  "email": "[email protected]",
  "identifier": "00******01",
  "identifier_type": "CPF",
}

Check our API Reference and 🇧🇷 Brazil OFPI guides to learn how to collect money directly into your customer’s bank account.

We now return metadata info in our payment webhooks

You asked. We listened! Our payment webhooks event now show metadata info. Here’s an example of what info you’ll get for a payment intent status_update webhook:

{
  "webhook_id": "3b9a69f7-0f0a-455b-832d-49ad6fd4905c",
  "webhook_type": "PAYMENT_INTENTS",
  "webhook_code": "STATUS_UPDATE",
  "object_id": "d2e40773-19f6-48d1-93c3-3590ec0c74df",
  "data": {
    "status": "SUCCEEDED", // The status of the payment intent.
    "metadata": {"internal_reference_id": "GGq12345w2"} 
  },
}

For more info, check our Payment webhooks article and API Reference.

Dashboard

🎉 New

Lending Analytics

We've released a new version of our Lending Analytics product that takes complete advantage of our improved Income Verification product! With this update, you can now quickly identify different types of income such as salary, government, interest, rent, retirement, freelance, alternative income, transfer, deposit, or unknown income.

New lending analytics section with expanded incomes

New lending analytics section with expanded incomes

Documentation Portal

💪 Improved

Added time-out limit to 408 request_timeout error description

To provide you with all the info you need, we refined our 408 request_timeout error description to include the actual time-out limit for requests, which is set to five (5) minutes. This error occurs when there is a very large amount of data and everything could not be retrieved within the allotted time. You can read more about it in our API and Widget Errors article. 🤓

Removed filters table from our API reference

We want our API Reference to be as simple as possible. That’s why we said goodbye to the extra tables that listed the filterable fields in our LIST methods. We’ve improved our query parameters info and centralized all the info there - now all you need to know to filter responses is in one place.

With ❤️, the definitely-not-trying-to-make-a-star-wars-pun Belvo development team.