Terminal API - Overview - Authsignal

Terminal Pairing

To integrate an Authsignal terminal with your point of sale system, you’ll need to obtain the terminalId from an on-boarded device. This unique identifier is required to authenticate requests to the payment session APIs from your point of sale terminal.

Terminal Request Identification

The Authsignal Payment Session API uses your terminalId as a value in the x-authsignal-terminal HTTP request header to identify requests.

curl --header 'x-authsignal-terminal: YOUR_TERMINAL_ID' https://api.authsignal.com/v1

Controller Authentication

The In-person Verification API lets a point of sale device, such as an iPad, send a digital ID verification to an Authsignal reader terminal. It authenticates with a controller token instead of a terminal ID. Contact Authsignal to issue a controller token for each point of sale device, and send it as a bearer token.

curl --header 'Authorization: Bearer YOUR_CONTROLLER_TOKEN' https://api.authsignal.com/v1

Region selection

Authsignal’s server SDKs default to the US (Oregon) region. If your tenant is in a different region, a different API URL must be configured.

Region	API URL
US (Oregon)	`https://api.authsignal.com/v1`
AU (Sydney)	`https://au.api.authsignal.com/v1`
EU (Ireland)	`https://eu.api.authsignal.com/v1`
CA (Montreal)	`https://ca.api.authsignal.com/v1`
UK (London)	`https://uk.api.authsignal.com/v1`

Download the Terminal API OpenAPI Specification

⌘I