Heimdall APIs

Query person status simple

POST

/v1/persons/status-simple

Summarized persons status from GOV.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

x-access-token

string

required

Body Params application/json

object | null

optional

filters

object | null

optional

Request filters.

personId

string

required

>= 11 characters<= 11 characters

webhook

string <uri> | null

optional

Webhook to return the result if request fail.

Example

{
  "filters": {
    "personId": "stringstrin"
  },
  "webhook": "http://example.com"
}

Responses

🟢200OK

application/json

Body

queryResult

object

required

personId

string

required

>= 11 characters<= 11 characters

fullName

string

required

socialName

string | null

optional

dateOfBirth

string <date>

required

dateOfDeath

optional

status

enum<string>

required

Allowed values:

regularsuspensatitular falecidopendente de regularizaçãocancelada por multiplicidadenulacancelada de ofício

isUnderAge

boolean

required

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": "nisi dolor ",
    "dateOfBirth": "1963-08-01",
    "status": "regular",
    "fullName": "pariatur dolore incididunt in",
    "dateOfDeath": null,
    "isUnderAge": true
  },
  "queryData": {
    "id": "quis velit culpa",
    "createdAt": "2023-11-07T00:03:57.532Z",
    "status": "in dolore sunt dolor",
    "webhook": null
  }
}

Modified at 2023-11-14 15:27:33

Query person status

Query person CAP BR