Umbrella API
Identity Verification
Verify a person's identity and address against authoritative datasources
What it returns
A per-datasource match result for a submitted identity and address, plus an aggregate score.
Request
POST /identity/verify
| Field | Required | Description |
|---|---|---|
identity.firstName | yes | |
identity.lastName | yes | |
identity.birthDate | yes | YYYY/MM/DD |
identity.nationalId | no | |
address.street | yes | |
address.postalCode | yes | |
address.city | yes | |
address.countryCode | yes | |
address.houseNumber / building / district / province | no | |
phone.phoneNumber | no |
Response
| Field | Type | Notes |
|---|---|---|
globalResult.totalScore | integer | Enum 0, 50, 75, 100 |
resultDetails[] | array | Per datasource: datasource, country, matches[] (record, match: full/partial/not-present) |
Decision
The caller decides from globalResult.totalScore and the per-record match values in
resultDetails.
Test cases
Pending.