In-person verifications

Get In-person Verification

Poll every one or two seconds until the status is COMPLETED, FAILED, CANCELLED or EXPIRED.

When the status is COMPLETED or FAILED, the response includes a result. Before you proceed, check that result.state is RESPONSE_RECEIVED, result.actionState is CHALLENGE_SUCCEEDED, and the credential has claimsVerified and deviceAuthVerified set to true and isn’t REVOKED. Read the claims you need from result.claims.

The verification is available until resultExpiresAt.

GET

terminal

proximity-verifications

{verificationId}

Get an in-person verification

curl --request GET \
  --url https://api.authsignal.com/v1/terminal/proximity-verifications/{verificationId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.authsignal.com/v1/terminal/proximity-verifications/{verificationId}"

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

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

print(response.text)

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

fetch('https://api.authsignal.com/v1/terminal/proximity-verifications/{verificationId}', 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.authsignal.com/v1/terminal/proximity-verifications/{verificationId}",
  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.authsignal.com/v1/terminal/proximity-verifications/{verificationId}"

	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.authsignal.com/v1/terminal/proximity-verifications/{verificationId}")

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

{
  "verificationId": "41feec4e-5a9e-46bd-9068-72261a57fc5d",
  "terminalId": "8c2d0e1b-5f4a-4c3e-9b8a-7d6c5b4a3f2e",
  "optionId": "age",
  "optionName": "Over 18",
  "reference": "sale-1042",
  "status": "COMPLETED",
  "createdAt": "2026-10-15T01:02:03.000Z",
  "expiresAt": "2026-10-15T01:07:03.000Z",
  "resultExpiresAt": "2026-10-15T01:12:03.000Z",
  "result": {
    "state": "RESPONSE_RECEIVED",
    "actionState": "CHALLENGE_SUCCEEDED",
    "claims": {
      "age_over_18": true,
      "portrait": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/..."
    },
    "credentials": [
      {
        "format": "mso_mdoc",
        "docType": "org.iso.18013.5.1.mDL",
        "claims": {
          "org.iso.18013.5.1": {
            "age_over_18": true,
            "portrait": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/..."
          }
        },
        "issuer": {
          "trusted": true,
          "country": "NZ"
        },
        "claimsVerified": true,
        "deviceAuthVerified": true
      }
    ]
  }
}

{
  "error": "terminal_busy",
  "errorCode": "terminal_busy",
  "errorDescription": ""
}

{
  "error": "terminal_busy",
  "errorCode": "terminal_busy",
  "errorDescription": ""
}

Authorizations

Authorization

string

header

required

Use the controller token issued for your point of sale device. Contact Authsignal to issue a controller token.

Path Parameters

verificationId

string

required

The ID of the in-person verification.

Response

verificationId

string

required

The ID of the in-person verification.

terminalId

string

required

The ID of the reader terminal the verification was sent to.

optionId

string | null

required

The request option the customer chose on the reader. null until they choose.

optionName

string | null

required

The display name of the chosen request option. null until the customer chooses.

status

enum<string>

required

PENDING until the reader picks up the verification, IN_PROGRESS while the customer chooses an option and presents their credential, and VERIFYING while Authsignal checks the response. COMPLETED, FAILED, CANCELLED and EXPIRED are final.

Available options:

PENDING,

IN_PROGRESS,

VERIFYING,

COMPLETED,

FAILED,

CANCELLED,

EXPIRED

createdAt

string<date-time>

required

expiresAt

string<date-time>

required

When the customer must have presented their credential by.

resultExpiresAt

string<date-time>

required

When the verification and its result stop being available.

reference

string

A reference identifier originating from the point of sale system.

result

object

Present once the status is COMPLETED or FAILED.

Show child attributes

⌘I

Get an in-person verification

curl --request GET \
  --url https://api.authsignal.com/v1/terminal/proximity-verifications/{verificationId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.authsignal.com/v1/terminal/proximity-verifications/{verificationId}"

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

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

print(response.text)

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

fetch('https://api.authsignal.com/v1/terminal/proximity-verifications/{verificationId}', 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.authsignal.com/v1/terminal/proximity-verifications/{verificationId}",
  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.authsignal.com/v1/terminal/proximity-verifications/{verificationId}"

	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.authsignal.com/v1/terminal/proximity-verifications/{verificationId}")

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

{
  "verificationId": "41feec4e-5a9e-46bd-9068-72261a57fc5d",
  "terminalId": "8c2d0e1b-5f4a-4c3e-9b8a-7d6c5b4a3f2e",
  "optionId": "age",
  "optionName": "Over 18",
  "reference": "sale-1042",
  "status": "COMPLETED",
  "createdAt": "2026-10-15T01:02:03.000Z",
  "expiresAt": "2026-10-15T01:07:03.000Z",
  "resultExpiresAt": "2026-10-15T01:12:03.000Z",
  "result": {
    "state": "RESPONSE_RECEIVED",
    "actionState": "CHALLENGE_SUCCEEDED",
    "claims": {
      "age_over_18": true,
      "portrait": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/..."
    },
    "credentials": [
      {
        "format": "mso_mdoc",
        "docType": "org.iso.18013.5.1.mDL",
        "claims": {
          "org.iso.18013.5.1": {
            "age_over_18": true,
            "portrait": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/..."
          }
        },
        "issuer": {
          "trusted": true,
          "country": "NZ"
        },
        "claimsVerified": true,
        "deviceAuthVerified": true
      }
    ]
  }
}

{
  "error": "terminal_busy",
  "errorCode": "terminal_busy",
  "errorDescription": ""
}

{
  "error": "terminal_busy",
  "errorCode": "terminal_busy",
  "errorDescription": ""
}

API reference

Server API

Client API

Management API

Call Connect API

Terminal API

Get In-person Verification

Authorizations

Path Parameters

Response