Document Verification Verify Age Service (Upcoming)

Document Verification Verify Age Service API Documentation

POST /verify/age

Verify Age and Disability

cURL

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
}
'

import requests

url = "https://api-umbrella.io/api/services/verify/age"

payload = {
    "journeyId": "uniqueJourneyIdentifier",
    "ageFrom": 21,
    "ageTo": 65,
    "minDisabilityPercentage": 50
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    journeyId: 'uniqueJourneyIdentifier',
    ageFrom: 21,
    ageTo: 65,
    minDisabilityPercentage: 50
  })
};

fetch('https://api-umbrella.io/api/services/verify/age', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-umbrella.io/api/services/verify/age",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'journeyId' => 'uniqueJourneyIdentifier',
    'ageFrom' => 21,
    'ageTo' => 65,
    'minDisabilityPercentage' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-umbrella.io/api/services/verify/age"

	payload := strings.NewReader("{\n  \"journeyId\": \"uniqueJourneyIdentifier\",\n  \"ageFrom\": 21,\n  \"ageTo\": 65,\n  \"minDisabilityPercentage\": 50\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-umbrella.io/api/services/verify/age")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"journeyId\": \"uniqueJourneyIdentifier\",\n  \"ageFrom\": 21,\n  \"ageTo\": 65,\n  \"minDisabilityPercentage\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-umbrella.io/api/services/verify/age")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"journeyId\": \"uniqueJourneyIdentifier\",\n  \"ageFrom\": 21,\n  \"ageTo\": 65,\n  \"minDisabilityPercentage\": 50\n}"

response = http.request(request)
puts response.read_body

200

{
  "journeyId": "<string>",
  "status": "ageAndDisabilityVerificationComplete",
  "ageResult": "yes",
  "disabilityResult": "eligible"
}

{
  "message": "Invalid request payload"
}

{
  "message": "Unauthorized request"
}

{
  "message": "Journey not found"
}

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 token obtained from POST /auth. Valid for 60 minutes.

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"