POST
/
verify
/
age
curl --request POST \
  --url https://api-umbrella.io/api/services/verify/age \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "journeyId": "uniqueJourneyIdentifier",
  "ageFrom": 21,
  "ageTo": 65,
  "minDisabilityPercentage": 50
}'
{
  "journeyId": "<string>",
  "status": "ageAndDisabilityVerificationComplete",
  "ageResult": "yes",
  "disabilityResult": "eligible"
}

For a usage description of the Document Verification Verify Age Service, please refer to the Document Verification page.

​
Endpoint

POST /verify/age

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
journeyId
string
required

Unique identifier for the verification journey.

Example:

"uniqueJourneyIdentifier"

​
ageFrom
number

Minimum age for eligibility (can't combine with ageTo).

Example:

21

​
ageTo
number

Maximum age for eligibility (can't combine with ageFrom).

Example:

65

​
minDisabilityPercentage
number

Minimum disability percentage required for eligibility.

Example:

50

Response

200
application/json
Successfully verified age and disability.
​
journeyId
string

Unique identifier for the verification journey.

​
status
string

Status of the verification process.

Example:

"ageAndDisabilityVerificationComplete"

​
ageResult
enum<string>

Indicates if the individual meets the age requirement.

Available options:
yes,
no
Example:

"yes"

​
disabilityResult
enum<string>

Indicates if the individual meets the disability criteria.

Available options:
eligible,
not eligible
Example:

"eligible"