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

x-access-token

string

required

Body Params application/json

filters

object

optional

Request filter.

fullName

string

optional

Player full name.

dateOfBrith

string

optional

Player date of birth.

Example

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

Responses

🟢200OK

application/json

Body

queryResult

object (Person CAP)

optional

Example:

{"personId":"11122233344","fullName":"Player Name","nickname":"Nickname","dateOfBirth":"12/04/1998","cofederation":"cbf","sport":"soccer","team":"Flamengo"}

personId

optional

fullName

string

optional

nickname

string

optional

dateOfBirth

string <date>

optional

cofederation

string

optional

sport

string

optional

team

string

optional

queryData

object (Query Result)

optional

Example:

{"id":"nkhxb6t5a49nzh3vipyx8hlw","createdAt":"2023-08-24T14:15:22Z","url":"api.example.com/v1/bet/players"}

string

required

Request ID

createdAt

string <date-time>

required

Created date of request.

webhook

string <uri> | null

required

status

string

required

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

Query person status simple

Query person PEP BR