Heimdall APIs
    Heimdall APIs
    • About
    • Authentication
      • Intro
      • Get access token
        POST
    • KYC
      • Query person status
        POST
      • Query person status simple
        POST
      • Query person CAP BR
        POST
      • Query person PEP BR
        POST
      • Get query result
        GET
    • Brazil
      • Zip code/CEP
        GET

    About

    📄 About#

    Intro#

    Our APIs will attempt to return the queried data at first request, but if some external/third-party data source is degradated the query will be queued to be processed asynchronous and you can check the result later using the queryId or the webhook provided will be called with the query result.

    Terminology#

    personId: Cadastro de Pessoas Físicas (CPF)
    kyc: key your customer
    pep: politically exposed person
    cap: confederation associated person
    Persons associated to a brazillian confederation. Like soccer players, referees, basket players, etc.
    sanctions: international sanctions list
    verifications: Proof of CPF registration status from brazillian gov.
    Modified at 2023-10-04 22:04:23
    Next
    Intro