Extract Employment Information in Brazil (API)

In this guide, we walk you through everything you need to extract employment data about your users using our API. This includes:

• A general overview of the data flow
• Generating your API keys
• Providing a webhook URL (to receive events from Belvo)
• Generating a widget access token and creating a link
• Getting employment and owner information

📘

What data can I get about my users?

For a detailed list of data that our Employment Record API returns for your users, see our:

• Dedicated Employment Data (Brazil) guide
• API Reference

General flow of data

👍

Average time to retrieve employment data

The average time it takes for Belvo to retrieve employment data from an employment institution and send you a webhook event is 15 seconds. However, this can vary depending on the institution's responsiveness and their current request load.

Belvo uses asynchronous workflows to improve your data flow (check the diagram below).

Belvo uses asynchronous workflows to improve your data flow (check the diagram below). Whenever your user successfully creates a link using the Hosted Widget, Belvo automatically extracts all the Employment data for you in the background, and once we have all the data, we notify you via a webhook that the data is ready to be retrieved (see the purple WEBHOOK sections in the diagram below). So that we can notify you once the data is ready, you need to provide a URL to where we can send events.

Generate API Keys

To use our API, you will need to generate some API keys to authenticate all your request.

To generate your API keys:

1. Sign in to your Belvo Dashboard.
2. Choose the Production environment to create your API keys.

   Note: Currently, employment data for Brazil is only supported in the production environment.

3. Go to Developers -> API Keys.
4. Click on Generate API Keys, which will automatically generate your API keys.
5. In the pop-up, copy and securely save the values for Secret ID and Secret Password.
   Note: In the pop-up, you also have the option of forking Belvo's API collection. For more information on how to use Postman and Belvo's collection, see our Getting started in 10 minutes guide.

✳️ Done! You've just generated your API keys! But before you can start making API calls, you just need to set up a webhook where we can send events to.

Add a webhook URL

📘

Just testing out?

If you're just starting your integration and aren't sure how to get a URL for a webhook, you can use a service like Pipedream. Check out our Getting started in 10ish minutes to see how it's done!

To set up a new webhook:

1. Sign in to your Belvo Dashboard.
2. Choose the Production environment to receive webhook events.
3. Go to Developers -> Webhooks.
4. Click +New webhook.
5. Fill in the New webhook form with the required information.
   1. URL: the URL to receive the webhook notifications.
   2. Authorization: an optional bearer token to use if your URL is protected.
6. Click Create webhook.

✳️ Done! You've now created a webhook and can start creating links and receiving events!

Whitelisting Belvo IP addresses

Belvo will send events to your webhook URL from the IP addresses listed below. Your security team may want to add these to their list of IP addresses that they allow events from (otherwise, your system may block events from reaching your system).

• 3.130.254.46
• 18.220.61.186
• 18.223.45.212

Generate an access token

For the widget to appear to your end users, you need to generate an access token in your server-side and send it to Belvo. Once we receive the request, you'll receive an object with two keys: access and refresh. Pass the value of the access key when starting the hosted widget.

🚧

The returned values are valid for 10 minutes and we invalidate the token as soon as a user successfully connects their account.

To generate an access token, simply make a call from your server-side to Belvo:

curl -X POST \
  https://production.belvo.com/api/token/ \
  -H 'Content-Type: application/json' \
  -H 'Host: production.belvo.com' \
  -d 'see example payloads below'

{
  "id": "YOUR_SECRET_ID",
  "password": "YOUR_SECRET_PASSWORD",
  "scopes": "read_institutions,write_links",
  "stale_in": "365d",
  "credentials_storage": "store",
  "fetch_resources": ["EMPLOYMENTS", "OWNERS"],
  "widget": {
    "callback_urls": {
      "success": "your_deeplink_here://success",
      "exit": "your_deeplink_here://exit",
      "event": "your_deeplink_here://error"
    },
    "branding": {
      "company_icon": "https://mysite.com/icon.svg",
      "company_logo": "https://mysite.com/logo.svg",
      "company_name": "ACME",
      "company_terms_url": "https://belvo.com/terms-service/",
      "overlay_background_color": "#F0F2F4",
      "social_proof": true
    },
    "theme": [] // See our dedicated widget customization article
  }
}

Where:

Start the widget in your application for your user

Next, you will need to redirect your user to the widget in a webview inside your application, using the access token you received from the /api/token/ request:

https://widget.belvo.io/
	?access_token={access_code}
  	&locale=pt
    &institutions=inss_br_employment
  	&access_mode=single
  	&external_id=HJLSI-897809

Additionally, check out ourStarting the widget and callback events sections of our Hosted Widget (Multi-Region) guide.

✳️ Done! Belvo will now connect to the institution and validate that the provided CPF is correct. Once validated and your link is created, Belvo will asynchronously load the employment data.We will send you a webhook once we have retrieved the data for the given link, and you can then extract it with a get request.

Wait for a webhook and get employment data

As soon as your banking recurrent link is created, we asynchronously load the employment information available for the link and will send you the following webhook:

In the webhook payload we include the number of employments found for the link.

{
  "webhook_id": "03d1ca0d62db4f769488265d141047b7",
  "webhook_type": "EMPLOYMENTS",
  "process_type": "historical_update",
  "webhook_code": "historical_update",
  "link_id": "2f5d361d-dad6-45d4-a0bf-26d479766067",
  "request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
  "external_id": "your_external_id",
  "data": {
    "total_employments": 1 // The total number of employment record profiles found for the link
  }
}

Once you receive the notification, you can get further details by making the following request:

curl --request GET 'https://api.belvo.com/api/br/employments/?link={id}' \
-u [Secret Key ID]:[Secret Key PASSWORD]

👍

For details about the response body, make sure to check out our List Employments (Brazil) API reference documentation or Employment (Brazil) Data Dictionary.

Wait for a webhook and get owner data

As soon as your banking link is created, we asynchronously load the owner information available for the link and will send you the following webhook:

In the webhook payload we include the number of owners found for the link.

{
  "webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
  "webhook_type": "OWNERS",
  "process_type": "historical_update",
  "webhook_code": "historical_update",
  "link_id": "16f68516-bcbc-4cf7-b815-c500d4204e28",
  "request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
  "external_id": "your_external_id",
  "data": {
    "total_owners": 2 // Total number of owners
  }
}

Once you receive the notification, you can get further details by making the following request:

curl --request GET 'https://api.belvo.com/api/owners/?link=link_id' \
-u [Secret Key ID]:[Secret Key PASSWORD]