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. Media upload is not used for registry verification.
In order to perform a social security number (SSN) validation the following fields must be provided:
idNumberfullnameORfirstName+lastNamedateofBirthORaddressdata- If
addressdata is provided, then send EITHERfullAddressvalue OR thestreet+houseNumber+postcodevalues
- If
Additional info
This is one of the two endpoints used to do SSN validation (hereinafter “default /validate-registry"). This endpoint is used by default and uses the API URL //example-base-url/v1/validate-registry.
When using this endpoint, the response returns info only about the request status, and includes some additional session related data. All the info about the person being verified is sent via webhook.
The other option is to use “sync-api /validate-registry” (hereinafter “sync-api /validate-registry”). This returns the info inside the API response payload. It is not available by default, you need to contact Veriff to use the sync-api /validate-registry.
See the API FAQ section for more info.
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 |
|---|---|
Jul 11, 2025 | Endpoint description updated to clarify the difference between /v1/validate-registry and sync-api/validate registry endpoints |
Apr 30, 2025 | New header |
Mar 12, 2025 | Documentation published |
Enter your description here