Social Assistance Beneficiaries - Request

Description

Initiates a check for the Social Assistance Beneficiaries IDV Solution, which verifies if the person being consulted is a beneficiary of government social and welfare benefits such as: Bolsa Família, Seguro Defeso and Benefício de Prestação Continuada (BPC).

Main benefits:

• Identifies if the user has received benefits in the last 3 or 6 months, allowing for the automation of workflow decisions.
• Ensures compliance with regulations, avoiding fines, sanctions, or other penalties that may be applied.
• Mitigation of reputational risks.
• Reduction of legal and regulatory risks.
• Prevention of fraud and money laundering.

The data originates from public information made available by different levels of government, either through files on transparency portals or centralized information systems.

Asynchronous Flow

This API uses an asynchronous two-step process:

1. Initiate the check — returns a ref ticket with status IN_PROGRESS (HTTP 202).
2. Poll for results — use the ref ticket to poll until the result is available (HTTP 200).

---

Step 1 — Initiate the check

HTTP method GET

Endpoint

https://api.msla-id.com/experience-idv-financial-api-v1/api/idv-govcheck/v1/br-identity/{CPF}/financial-info

[SANDBOX Environment]

For testing purposes, use the base domain: apidev.msla-id.com

Request header parameter

NAME	REQUIRED	TYPE	DESCRIPTION
Authorization	✅	string	Bearer JWT token

URI request parameter

NAME	REQUIRED	TYPE	DESCRIPTION
CPF	✅	string	CPF number (digits only).

Status code responses

Code	Description
202	Check initiated
400	Bad request
401	Unauthorized
403	Forbidden
500	Internal server error

The full documentation error codes can be found here.

Response 202 status code

{
  "ref": "06479633377-fi-a1b2c3d4",
  "status": "IN_PROGRESS"
}

Response 400 status code

{
    "traceId": "542fc743fffda052",
    "timestamp": "2023-05-05 11:20:46",
    "code": "IDV-3001",
    "message": "Bad request - Invalid or incomplete input data"
}

Response 500 status code

{
    "traceId": "43a20f33d4e8730d",
    "timestamp": "yyyy-mm-dd HH:MM:SS",
    "code": "IDV-1008",
    "message": "Error in the source of origin, please contact an administration."
}