Validates a national ID number (e.g. social security number (SSN)) with the provided data
A verification session will be automatically created and submitted. After that, the validation result is sent via webhook.
You will need a separate integration to do this verification, ask your Solutions Engineer to set it up. Media upload is not used for registry verification.
In order to perform a social security number (SSN) validation the following fields must be provided:
idNumber
fullname
ORfirstName
+lastName
dateofBirth
ORaddress
data- If
address
data is provided, then send EITHERfullAddress
value OR thestreet
+houseNumber
+postcode
values
- If
Note: always ensure that you use the correct API URL to send requests. See the API URL section for more info.
Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")
Your Integration's ID. Required when the flexible API keys solution is used
Session initalization data
Verification object
The callback URL to where the end-user is redirected after the verification session is completed. Default is visible in the Veriff Customer Portal > Settings. Changing the value in this request body will overwrite the default callback URL, but it will not change the callback URL that is visible in the Customer Portal.
Data about the person being verified
Person's social security number (SSN).
Person's full name. Required if firstName
+ lastName
is not provided
Person's first name. Required if fullName
is not provided
Person's last name. Required if fullName
is not provided
Person's date of birth. Required if address
is not provided
Person's phone number, can include numbers, whitespaces and the "+" sign in front
Data about the address of the person being verified
Full address. Required if street
+ houseNumber
+ postcode
is not provided
Street. Required if fullAddress
is not provided
House number. Required if fullAddress
is not provided
Postal code. Required if fullAddress
is not provided
City
State
Apartment number
The unique identifier that you created for your end-user. It can be max 1,000 characters long and contain only non-semantic data that can not be resolved or used outside your systems or environments. Veriff returns it unmodified in webhooks and API response payloads, or as null
if not provided
Created session
API request status
Verification object
UUID v4 which identifies the verification session
The unique identifier that you created for your end-user. It can be max 1,000 characters long and contain only non-semantic data that can not be resolved or used outside your systems or environments. Veriff returns it unmodified in webhooks and API response payloads, or as null
if not provided
Verification session status
Session-specific token of the verification
Bad request
Unauthorized
Internal server error
Article Versioning
Date | Description |
---|---|
Apr 30, 2025 | New header |
Mar 12, 2025 | Documentation published |
Enter your description here