Creating Basic Data Review
Introduction
- This is used to review a taxId (Brazilian CPF or CNPJ) on Receita Federal.
How to Create a Basic Data Review
To create a basic data review, you need to call the Create review endpoint:
curl --location --request POST 'https://faas.sandbox.tracefinance.io/customerCompliance/api/reviews' \
--header 'Content-Type: application/json' \
--header 'authorization: Bearer {accessToken}' \
--data '{
"customer":{
"taxId":"{taxId}"
},
"referenceId": "{referenceId}",
"searches":[
"BASIC_DATA"
]
}
'
Parameters:
{taxId}
: This is the customer's tax ID, which can be either CPF or CNPJ.{referenceId}
: If you want it is possible to send us your referenceId it will help you to identify and match the webhooks.
Resulting Status:
- The endpoint will respond with a status code of 201 with the response below:
{
"id": "42abb069-f312-4a9b-aea1-d5ec63f2bf2d",
"searches": [
"BASIC_DATA"
],
"companyId": "864a44cd-9bc7-43b5-a44b-9d7661cd6ec9",
"referenceId": "REF-123"
"currentStatus": "CREATED",
"createdAt": "2024-09-09T13:55:30.5520Z",
"updatedAt": "2024-09-09T13:55:30.5520Z"
}
- Some webhooks will be sent in each step of the review.
Webhooks
- The REVIEW_CREATED webhook is triggered when the review is created.
- The REVIEW_REVIEWING webhook is triggered when the review progresses.
- The REVIEW_VALID webhook is triggered when the review is successful.
- The REVIEW_FAILED webhook is triggered when the review fails.
Sandbox Environment
- If you wish to perform a failure test:
- for a person's CPF enter the value
12345678909
in thetaxId
field - for a company's CNPJ enter the value
50676745000143
in thetaxId
field
- for a person's CPF enter the value
- After some seconds a REVIEW_FAILED webhook will be sent.
Updated 2 months ago