Bit Capital

The Bit Capital Developer Hub

Welcome to the Bit Capital developer hub. You'll find comprehensive guides and documentation to help you start working with the platform as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides    Community

Validating informations on Bureaus

It's very common for a fintech to need to validate informations provided by it's users for compliance reasons. We at Bit Capital care a lot about that and thinking of it we provide a way for you to retrieve informations from a lot of different sources about a certain taxId in a single request. This helps you make better decisions about which client you should approve or not and protect your business from fraud and money laundering.

People Search

Whenever you need to retrieve informations from a certain person you can make a request to GET /kyc/people/preview. The response should be something like the one below:

{
    "accepted": true,
    "basic": {
        "createdAt": "2020-02-12T18:32:42.222Z",
        "updatedAt": "2020-02-27T21:10:23.004Z",
        "addresses": [
            {
                "city": "SAO PAULO",
                "code": "01234567",
                "state": "SP",
                "number": "222",
                "street": "AVENIDA 9 de Julho",
                "reference": "",
                "neighborhood": "MY NEIGHBORHOOD"
            }
        ],
        "phones": [
            {
                "code": "11",
                "number": "38422222",
                "weight": 0,
                "provider": "TelefĂ´nica Brasil",
                "countryCode": "55"
            },
        ],
        "motherName": "MY MOTHER NAME",
        "emails": [
            "[email protected]"
        ],
        "birthCountry": "Brasileiro",
        "birthDate": "1900-01-20T00:00:00.000Z",
        "gender": "male",
        "taxIdStatus": "active",
        "taxIdStatusUpdatedAt": "2020-02-27T00:00:00.000Z",
        "name": "JOAO BRITO",
        "taxId": "01234567890",
        "id": "e86125a4-6246-4811-93e7-6797fbfb8a10"
    },
    "report": {
        "flags": {
            "sactionHistory": [
                {
                    "source": "interpol",
                    "type": "Law Enforcement",
                    "matchRate": 50,
                    "nameUniquenessScore": 1,
                    "details": {
                        "sanctionName": "JOAO PAULO FERREIRA MARQUES",
                        "nationalities": "PORTUGAL",
                        "charges": "almacenamiento de sustancias estupefacientes con fines de comercializacion y contrabando de exportacion calificado de estupefacientes en grado de tentativa agravado por el numero de intervinientes y asociacion ilicita en calidad de jefe en concurso real"
                    },
                    "startedAt": "0001-01-01T00:00:00",
                    "endedAt": "9999-12-31T23:59:59.9999999",
                    "createdAt": "2020-04-04T01:09:31.49Z",
                    "updatedAt": "0001-01-01T00:00:00"
                }
            ],
            "politicalHistory": [],
            "isFinanciallySanctioned": false,
            "isPoliticallyExposed": false,
            "accepted": true,
            "taxId": "01795412186"
        },
        "person": {
            "taxId": "01234567890",
            "name": "JOAO BRITO",
            "id": "e86125a4-6246-4811-93e7-6797fbfb8a10"
        },
        "accepted": true,
        "id": "e82fe348-0db2-49ab-bb1a-b77f7da3cdd1"
    }
}

Company Search

For companies the request should be done to GET /kyc/companies/preview.

Billing for Bureau Check

You can use our billing system to create service fees for consulting data, you can check out more informations about it in the Billing Overview section.

🚧

Best Practice

The field motherName must be the same as found in the Bureau. We have a lot of bottleneck at this point if this is filled with maiden name of persons's mother.
In cases the value in the bureau differs from the one in the document, you should open a ticket on our help desk for us to whitelist this specific taxId.

Updated 4 months ago


Validating informations on Bureaus


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.