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
  1. KYC

Query person PEP BR

POST
https://api.heimdall.watch/kyc/v1/persons/pep-br
Get person PEP BR

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Header Params
x-access-token
string 
required
Body Params application/json
filters
object 
required
personId
string 
required
>= 11 characters<= 11 characters
webhook
string <uri> | null 
optional
Example
{
    "filters": {
        "personId": "stringstrin"
    },
    "webhook": "http://example.com"
}

Responses

🟢200OK
application/json
Body
queryResult
array[object (Person PEP) {12}] 
optional
personId
string  | null 
optional
name
string 
optional
aliases
string  | null 
optional
dateOfBirth
optional
countries
string  | null 
optional
addresses
string  | null 
optional
identifiers
string  | null 
optional
sanctions
string  | null 
optional
phones
string  | null 
optional
emails
string  | null 
optional
sourceName
string 
optional
sourceUrl
string 
optional
queryData
object (Query Result) 
optional
Example:
{"id":"nkhxb6t5a49nzh3vipyx8hlw","createdAt":"2023-08-24T14:15:22Z","url":"api.example.com/v1/bet/players"}
id
string 
required
Request ID
createdAt
string <date-time>
required
Created date of request.
webhook
string <uri> | null 
required
status
string 
required
Example
{
    "queryResult": [
        {
            "personId": "string",
            "name": "string",
            "aliases": "string",
            "dateOfBirth": "2019-08-24",
            "countries": "string",
            "addresses": "string",
            "identifiers": "string",
            "sanctions": "string",
            "phones": "string",
            "emails": "string",
            "sourceName": "string",
            "sourceUrl": "string"
        }
    ],
    "queryData": {
        "id": "nkhxb6t5a49nzh3vipyx8hlw",
        "createdAt": "2023-08-24T14:15:22Z",
        "url": "api.example.com/v1/bet/persons/11122233344/pep-br"
    }
}
Modified at 2023-11-14 15:27:54
Previous
Query person CAP BR
Next
Get query result