POST
Start automatic address verification

Authorizations

x-api-key
string
header
required

Headers

x-tenant
string
required

Tenant identifier

Path Parameters

entityId
string
required

Body

application/json
countryCode
string

Country calling code. Currently only Saudi Arabia is supported and must be exactly '966'. Required for individual entities.

Example:

"966"

phoneNumber
string

User mobile phone number used to receive the verification code. Required for individual entities.

Example:

"512345678"

Response

Success

otp
enum<string>
Available options:
Valid,
Invalid
data
object[] | null