Request KYC Analisys - Consumer
POST
/api/kyc/analisys
Request
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://baas-api.np.bankei.com.br/api/kyc/analisys' \
--header 'x-signature: ' \
--header 'x-timestamp: ' \
--header 'x-endpoint: ' \
--header 'x-org-id: ' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"flowType": "ConsumerForBankingBr",
"countryCode": "BR",
"userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"personalData": {
"consumer": {
"taxId": "12345678901",
"fullName": "Maria Silva Santos",
"mobilePhoneAreaCode": "11",
"mobilePhoneNumber": "987654321",
"landlineAreaCode": "11",
"landlineNumber": "32145678",
"email": "maria.silva@example.com",
"familyIncome": 8500.00,
"document": {
"type": "RG",
"number": "123456789",
"issueDate": "2018-05-15T00:00:00Z",
"issuingAgency": "SSP",
"issuingState": "SP"
},
"birthDate": "1990-03-20T00:00:00Z",
"birthPlaceState": "SP",
"birthPlaceCity": "São Paulo",
"isPep": false,
"motherName": "Ana Silva Santos",
"primaryAddress": {
"postalCode": "01310100",
"city": "São Paulo",
"neighborhood": "Bela Vista",
"state": "SP",
"streetName": "Avenida Paulista",
"streetNumber": "1578",
"complement": "Apto 102"
}
}
},
"termsData": {
"version": "1.0.0",
"accepted": true
}
}'Response Response Example
200 - Success
{
"id": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"flowType": "ConsumerForBankingBr",
"countryCode": "BR",
"isApproved": false,
"steps": [
{
"id": "019937c1-f509-777d-8a11-4a862dbdaa46",
"name": "AcceptTerms",
"type": "Terms",
"status": "SUCCESS",
"statusReason": null,
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220173+00:00"
},
{
"id": "019937c1-f50a-7195-8ba9-f4fa2e9ec1f0",
"name": "Liveness",
"type": "Liveness",
"status": "NON-MANDATORY",
"statusReason": "step not started, but not mandatory for this level",
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220197+00:00"
},
{
"id": "019937c1-f50a-7196-a85a-6213f7e6be33",
"name": "FaceMatch",
"type": "DocumentCheck",
"status": "PENDING",
"statusReason": null,
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220202+00:00"
},
{
"id": "019937c1-f50a-7197-b1d6-1b711c245128",
"name": "IdentityDocumentFront",
"type": "DocumentCheck",
"status": "PENDING",
"statusReason": null,
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220207+00:00"
},
{
"id": "019937c1-f50a-7198-b722-d537b4d3fef6",
"name": "IdentityDocumentBack",
"type": "DocumentCheck",
"status": "PENDING",
"statusReason": null,
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220211+00:00"
},
{
"id": "019937c1-f50a-7199-b5ce-fa38f15f07ea",
"name": "Selfie",
"type": "DocumentCheck",
"status": "PENDING",
"statusReason": null,
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220239+00:00"
},
{
"id": "019937c1-f50a-719a-8758-f25159c29989",
"name": "OCR",
"type": "DocumentCheck",
"status": "PENDING",
"statusReason": null,
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220243+00:00"
},
{
"id": "019937c1-f50a-719b-a84c-9576361a4c7e",
"name": "DataRating",
"type": "RegistrationCheck",
"status": "SUCCESS",
"statusReason": "automatic approval for sandbox environment",
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220247+00:00"
},
{
"id": "019937c1-f50a-719c-8b0d-6c25b74f2b94",
"name": "BasicInfos",
"type": "RegistrationCheck",
"status": "SUCCESS",
"statusReason": "automatic approval for sandbox environment",
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220251+00:00"
},
{
"id": "019937c1-f50a-719d-8f3a-95fec58f8588",
"name": "FraudScore",
"type": "FraudCheck",
"status": "SUCCESS",
"statusReason": "automatic approval for sandbox environment",
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220256+00:00"
},
{
"id": "019937c1-f50a-719e-b9b1-b90402ee98df",
"name": "ReceitaFederal",
"type": "BackgroungCheck",
"status": "SUCCESS",
"statusReason": "automatic approval for sandbox environment",
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220259+00:00"
},
{
"id": "019937c1-f50a-719f-9361-80712c1e3446",
"name": "NationalRestrictiveLists",
"type": "BackgroungCheck",
"status": "SUCCESS",
"statusReason": "automatic approval for sandbox environment",
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220263+00:00"
},
{
"id": "019937c1-f50a-71a0-8623-8e426fbae62c",
"name": "InternationalRestrictiveLists",
"type": "BackgroungCheck",
"status": "SUCCESS",
"statusReason": "automatic approval for sandbox environment",
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220267+00:00"
},
{
"id": "019937c1-f50a-71a1-b068-3c1c4f5ba6d6",
"name": "ArrestWarrant",
"type": "BackgroungCheck",
"status": "SUCCESS",
"statusReason": "automatic approval for sandbox environment",
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.122027+00:00"
},
{
"id": "019937c1-f50a-71a2-99ec-d5d3cffb629a",
"name": "PEP",
"type": "BackgroungCheck",
"status": "SUCCESS",
"statusReason": "automatic approval for sandbox environment",
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220273+00:00"
},
{
"id": "019937c1-f50a-71a3-a4b5-3452b882618e",
"name": "Manual",
"type": "ManualCheck",
"status": "NON-MANDATORY",
"statusReason": "step will be executed if a need for manual analysis is detected",
"analisysId": "019937c1-f509-777c-b763-7e0da6917e77",
"userId": "019937b1-5a71-713d-87ac-4deb590db2d5",
"version": 1,
"additionalData": null,
"createdAt": "2025-09-11T07:51:22.1220277+00:00"
}
],
"createdAt": "2025-09-11T07:51:22.1219908+00:00"
}Modified at 2026-01-12 11:51:25