Skip to main content

Challenge Flow

After executing a credit analysis, it's possible that the decision challenges the user to perform a new action on your platform. This flow can be used, for example, to request proof of income from a user whose approval or denial is not yet certain.

There are two ways to use this flow: one is automated, and the other is the result of a manual decision by an analyst. For the first, the returned analysis_status will be automatically_challenged, and for the second, it will be manually_challenged. The flow is described below.

Step-by-step of the Flow Execution​

1. A proposal is submitted for analysis (see section Credit Analysis - Natural Person or Credit Analysis - Legal Person), and it will return the status automatically_challenged or in_manual_analysis.

Request Body
{
  "id": "12345",
  "registration_id":"12345",
  "credit_request_date": "2021-03-31T10:30:00-03:00",
  "credit_type": "clean",
  "name": "Victor Silva Barbosa",
  "document_number": "199.208.915-92",
  ...
}
Response Body
{
  "id": "12345",
  "analysis_status": "automatically_challenge"
}

If the request returns the status in_manual_analysis in the response, the analyst can, through the dashboard, challenge the user. In this case, the status sent in the webhook request will be manually_challenged.

Response Body
{
  "id": "12345",
  "analysis_status": "manually_challenged"
}

2. After the first analysis request has returned one of the two challenge analysis_status values, a new request must be sent with the additional information collected from the customer, such as a new uploaded document image. This request must contain the same registration_id as the previous request, since this field will be used by the platform to identify that both requests refer to the same user, as well as to link the additional information collected from the customer.

Request Body: Submission with additional information
{
  "id": "67890",
  "registration_id":"12345",
  "credit_request_date": "2021-03-31T10:30:00-03:00",
  "credit_type": "clean",
  "name": "Victor Silva Barbosa",
  "document_number": "199.208.915-92",
  "documents": {    
    "cnh": {
      "ocr_key":"a5cf9c8f-2f66-4490-a7db-8a5bc70c1b76"
    }
  }
  ...
}
Response Body
{
  "id": "12345",
  "analysis_status": "automatically_approved"
}