POST
/
identity
/
verify
Verify Identity
curl --request POST \
  --url https://sandbox-umbrella-api.azurewebsites.net/api/services/identity/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "raw": true,
  "identity": {
    "firstName": "<string>",
    "lastName": "<string>",
    "nationalId": "<string>",
    "birthDate": "<string>"
  },
  "address": {
    "street": "<string>",
    "houseNumber": "<string>",
    "building": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "district": "<string>",
    "province": "<string>",
    "countryCode": "<string>"
  },
  "phone": {
    "phoneNumber": "<string>"
  }
}'
{
  "globalResult": {
    "totalScore": 0
  },
  "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

Flag to request raw data return. Defaults to false.

​
phone
object

Response

Successfully retrieved the verification results.

​
globalResult
object
required
​
resultDetails
object[]
required