POST
/
identity
/
verify
curl --request POST \
  --url https://api-umbrella.io/api/services/identity/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "raw": false,
  "identity": {
    "firstName": "John",
    "lastName": "Doe",
    "nationalId": "123456789",
    "birthDate": "1985/05/15"
  },
  "address": {
    "street": "Main Street",
    "houseNumber": "123",
    "building": "Apt 4B",
    "postalCode": "10001",
    "city": "New York",
    "district": "Manhattan",
    "province": "NY",
    "countryCode": "US"
  },
  "phone": {
    "phoneNumber": "+1234567890"
  }
}'
{
  "globalResult": {
    "totalScore": 100
  },
  "resultDetails": [
    {
      "datasource": "<string>",
      "country": "<string>",
      "matches": [
        {
          "record": "<string>",
          "match": "full"
        }
      ]
    }
  ]
}

For a usage description of the Identity Verification Service, please refer to the Identity Verification page.

​
Endpoint

POST /identity/verify

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
identity
object
required
​
address
object
required
​
raw
boolean
default:false

Flag to request raw data return. Defaults to false.

​
phone
object

Response

200
application/json
Successfully retrieved the verification results.
​
globalResult
object
​
resultDetails
object[]

Lists detailed match results from various data sources.