Bankei BaaS Admin
  1. KYC
Bankei BaaS Admin
  • Introduction
  • API Security and Authentication
  • Handling Monetary Values in Our System
  • Secure API Credential Exchange Process
  • Organization
    • Get Organization
      GET
  • Admin Account
    • Get Account Information
      GET
  • User
    • Create User - Basic
      POST
    • Get User
      GET
  • KYC
    • Request KYC Analisys - Company
      POST
    • Get KYC Analisys Status
      GET
    • Request KYC Analisys - Consumer
      POST
    • Send KYC Document
      POST
  • Checking Account
    • Get Account Information
      GET
    • Get Account Balance
      GET
    • Create Checking Account
      POST
    • Get Account Transactions
      GET
  • Card
    • Get Card Groups
      GET
    • Create Nominated Card
      POST
    • Get Cards
      GET
    • Get Card Shipping
      GET
    • Activate Nominated Card
      POST
    • Temporary Disable Card
      POST
    • Enable Temporary Disable Card
      POST
    • Block Card
      POST
    • Get Card Sensitive Information
      GET
  • Pix
    • Generate Pix-In Static BR Code
    • Generate Pix-In Dynamic Cob BR Code
    • Generate Pix-In Dynamic CobV BR Code
    • Get Account Pix Keys
    • Generate Pix Key
  • Pix Out
    • Preview Pix BrCode Payment
    • Preview Pix Key Payment
    • Confirm Pix Payment
  • Bill Payment
    • Line vs. Barcode
    • Bill Payment Preview
    • Create Bill Payment
  • Invoice
    • Generate Invoice
  • Receipt
    • Get Transaction Receipt
  • Webhook
    • Bill Payment Webhook Events
    • Create Webhook Subscription
    • Get Webhook Subscriptions
    • Delete Webhook Subscription
    • Get Webhook Events
    • Get Webhook Event Detail
    • Get Webhook Send Attempts
    • Get Webhook Send Attempt Detail
    • Dispatch Webhook Events
  • Sandbox
    • Pay Pix BrCode [Sandbox Only]
    • Confirm Bill Payment [Sandbox Only]
    • Reject Bill Payment [Sandbox Only]
    • Approve Kyc Analisys [Sandbox Only]
  • Schemas
    • Account
    • Asset
    • Metadata
    • Address
    • Consumer
  1. KYC

Get KYC Analisys Status

GET
/api/kyc/analisys

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Query Params

Header Params

Responses

🟢200OK
application/json
Body

🟠404 Not Found
🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://baas-api.np.bankei.com.br/api/kyc/analisys?userId=0298f43d-a517-9fe6-d5d3-0hc9f083eff9&analisysId=' \
--header 'x-signature: ' \
--header 'x-timestamp: ' \
--header 'x-endpoint: ' \
--header 'x-org-id: ' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Success
{
    "id": "0298f43c-36d1-8c95-bf29-g3c929fe4d20",
    "userId": "0298f43d-a517-9fe6-d5d3-0hc9f083eff9",
    "flowType": "ConsumerForBankingBr",
    "countryCode": "BR",
    "isApproved": false,
    "steps": [
        {
            "id": "019b9de9-8ac8-73bd-950b-9ff02a5b1b4a",
            "name": "FaceMatch",
            "type": "DocumentCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.984765+00:00"
        },
        {
            "id": "019b9de9-8ac8-73c1-b8f5-38852ac297b8",
            "name": "OCR",
            "type": "DocumentCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.984774+00:00"
        },
        {
            "id": "019b9de9-8ac8-73c2-906f-3a2bbe1675e8",
            "name": "DataRating",
            "type": "RegistrationCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.984776+00:00"
        },
        {
            "id": "019b9de9-8ac8-73c3-8b6b-9243462d0d86",
            "name": "BasicInfos",
            "type": "RegistrationCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.984777+00:00"
        },
        {
            "id": "019b9de9-8ac8-73c4-a68c-a98ee3250f60",
            "name": "FraudScore",
            "type": "FraudCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.984779+00:00"
        },
        {
            "id": "019b9de9-8ac8-73c5-8980-f8b30499c965",
            "name": "ReceitaFederal",
            "type": "BackgroungCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.98478+00:00"
        },
        {
            "id": "019b9de9-8ac8-73c6-a33b-c0375d9a628b",
            "name": "NationalRestrictiveLists",
            "type": "BackgroungCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.984782+00:00"
        },
        {
            "id": "019b9de9-8ac8-73bf-a2ea-4c414d20bee7",
            "name": "IdentityDocumentBack",
            "type": "DocumentCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.984768+00:00"
        },
        {
            "id": "019b9de9-8ac6-755f-8d2a-bda0b0d527fd",
            "name": "AcceptTerms",
            "type": "Terms",
            "status": "SUCCESS",
            "statusReason": null,
            "createdAt": "2026-01-08T14:01:26.984469+00:00"
        },
        {
            "id": "019b9de9-8ac8-73c0-a0f7-0815f5b87f82",
            "name": "Selfie",
            "type": "DocumentCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.98477+00:00"
        },
        {
            "id": "019b9de9-8ac8-73be-9770-12eca0f05bf7",
            "name": "IdentityDocumentFront",
            "type": "DocumentCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.984767+00:00"
        },
        {
            "id": "019b9de9-8ac8-73bc-8d4f-2d27f61ecb46",
            "name": "Liveness",
            "type": "Liveness",
            "status": "NON_MANDATORY",
            "statusReason": "step not started, but not mandatory for this level",
            "createdAt": "2026-01-08T14:01:26.984762+00:00"
        },
        {
            "id": "019b9de9-8ac8-73ca-ac15-7044cc6a7298",
            "name": "Manual",
            "type": "ManualCheck",
            "status": "NON_MANDATORY",
            "statusReason": "step will be executed if a need for manual analysis is detected",
            "createdAt": "2026-01-08T14:01:26.984787+00:00"
        },
        {
            "id": "019b9de9-8ac8-73c7-bdd6-c7c3494d3a7d",
            "name": "InternationalRestrictiveLists",
            "type": "BackgroungCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.984783+00:00"
        },
        {
            "id": "019b9de9-8ac8-73c8-8c3e-b182cfd244e6",
            "name": "ArrestWarrant",
            "type": "BackgroungCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.984785+00:00"
        },
        {
            "id": "019b9de9-8ac8-73c8-8fa5-d571fac782d1",
            "name": "LegalProceedings",
            "type": "BackgroungCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.984785+00:00"
        },
        {
            "id": "019b9de9-8ac8-73c9-8663-12237a0394f4",
            "name": "PEP",
            "type": "BackgroungCheck",
            "status": "PROCESSING",
            "statusReason": "Information sent for analysis, please wait for processing.",
            "createdAt": "2026-01-08T14:01:26.984786+00:00"
        }
    ],
    "personalData": {
        "consumer": {
            "taxId": "98765432100",
            "fullName": "Maria Oliveira",
            "mobilePhoneAreaCode": "31",
            "mobilePhoneNumber": "999711110",
            "landlineAreaCode": null,
            "landlineNumber": null,
            "email": "maria.oliveira@gmail.com",
            "familyIncome": 1000,
            "document": {
                "type": 1,
                "number": "30012225",
                "issueDate": null,
                "issuingAgency": null,
                "issuingState": null
            },
            "birthDate": "2003-02-10T00:00:00",
            "birthPlaceState": 29,
            "birthPlaceCity": "São Paulo",
            "isPep": false,
            "motherName": null,
            "primaryAddress": {
                "postalCode": "21455000",
                "city": "São Paulo",
                "neighborhood": "Centro",
                "state": 29,
                "streetName": "Rua das Flores",
                "streetNumber": "22",
                "complement": null
            }
        }
    },
    "termsData": {
        "version": "1",
        "accepted": true
    },
    "createdAt": "2026-01-08T14:01:26.979926+00:00"
}
Modified at 2026-01-22 14:45:07
Previous
Request KYC Analisys - Company
Next
Request KYC Analisys - Consumer
Built with