Applications

Read the identity verification of the applicant and each director and shareholder

The applicant’s outcome on record and current attempt. While an attempt is pending, its decision is read (at most every 15 seconds) and applied, so the state does not wait on the webhook alone. persons lists every director and every shareholder at or above the ownership threshold with the state of their own verification; a pending person’s decision is read at most once a minute. The applicant’s verified or waived outcome satisfies the identity requirement of POST /v2/applications//submit. The hosted link is not returned here; POST /v2/applications//identity-verification/session starts an attempt with a new one.

GET

applications

{id}

identity-verification

Read the identity verification of the applicant and each director and shareholder

curl --request GET \
  --url https://api.example.com/v2/applications/{id}/identity-verification \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/v2/applications/{id}/identity-verification"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v2/applications/{id}/identity-verification', 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.example.com/v2/applications/{id}/identity-verification",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/v2/applications/{id}/identity-verification"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/applications/{id}/identity-verification")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "persons": [
    {
      "linkEmailedAt": "2023-11-07T05:31:56Z",
      "personId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "not_started",
      "verifiesByLink": true
    }
  ],
  "sessionId": "<string>",
  "status": "pending",
  "submittedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Authorizations

Authorization

string

header

required

Enter Auth0 JWT token

Path Parameters

string<uuid>

required

Response

persons

object[]

required

Each director's and large shareholder's own identity verification. Empty for an individual application.

Show child attributes

sessionId

string | null

required

The current attempt's session id; null for a waive, before any attempt, and in the sandbox, where starting a session verifies the applicant at once.

status

enum<string> | null

required

The outcome on record. pending while an attempt is open; verified or waived satisfies the identity requirement of POST /v2/applications/{id}/submit; rejected ends an attempt without a pass, and a new session may be started. Null until an attempt is started or the step is waived, and after a change to the applicant’s identity details withdraws a pass.

Available options:

pending,

verified,

rejected,

waived

submittedAt

string<date-time> | null

required

When the attempt reached its outcome or was waived.

Read the identity verification of the applicant and each director and shareholder

curl --request GET \
  --url https://api.example.com/v2/applications/{id}/identity-verification \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/v2/applications/{id}/identity-verification"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v2/applications/{id}/identity-verification', 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.example.com/v2/applications/{id}/identity-verification",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/v2/applications/{id}/identity-verification"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/applications/{id}/identity-verification")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "persons": [
    {
      "linkEmailedAt": "2023-11-07T05:31:56Z",
      "personId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "not_started",
      "verifiesByLink": true
    }
  ],
  "sessionId": "<string>",
  "status": "pending",
  "submittedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}