Heimdall APIs
  1. KYC
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
  • Schemas
    • Schemas
      • Fields
        • Person ID (CPF)
        • fullName
        • motherFullName
        • Date of birth
        • Date of death
        • Webhook
        • personStatus
      • Query Result
      • Person
      • Person CAP
      • Person PEP
      • Person KYC
      • Person Verification
      • Verification
      • address
  1. KYC

Query person CAP BR

POST
https://api.heimdall.watch/kyc/v1/persons/cap-br
Get player by name and date of birth.

Request

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

Body Params application/json

Example
{
    "filters": {
        "fullName": "string",
        "dateOfBrith": "string"
    }
}

Responses

🟢200OK
application/json
Body

Example
{
    "queryResult": {
        "personId": "11122233344",
        "fullName": "Player Name",
        "nickname": "Nickname",
        "dateOfBirth": "12/04/1998",
        "cofederation": "cbf",
        "sport": "soccer",
        "team": "Flamengo"
    },
    "queryData": {
        "id": "nkhxb6t5a49nzh3vipyx8hlw",
        "createdAt": "2023-08-24T14:15:22Z",
        "url": "api.example.com/v1/bet/players"
    }
}
Modified at 2023-11-14 15:27:48
Previous
Query person status simple
Next
Query person PEP BR