verification

Submit licensed professional data against program

Using this endpoint starts a verification and submits personal info in one request, and is the equivalent to POSTing to /verification and then /verification/{verificationId}/step/collectLicensedProfessionalPersonalInfo

post/verification/program/{programId}/step/collectLicensedProfessionalPersonalInfo

Path parameters

programIdstring required

Unique identifier for the program to use for verification

Request body

firstNamestring required

The first name of the person being verified

lastNamestring required

The last name of the person being verified

deviceFingerprintHashstring

The device fingerprint collected for the person being verified

emailstring required

The email address of the person being verified

birthDatestring date required

The date of birth of the person being verified (format YYYY-MM-DD). Date must be greater than 1900-01-01.

postalCodestring required

The postal code for the person being verified

statusesLicensedProfessionalStatus[] required

List of licensed professional statuses. A single value will be interpreted as a list with one entry.

countrystring nullable

The ISO 3166-1 alpha-2 country code of the person being verified. In a response, the value can be null if the verification has no country.

phoneNumberstring

The phone number used for SMS messages

localestring

The locale chosen by the user

ipAddressstring ipv4

The end-user's public IP address. This only needs to be provided in situations where the HTTP requests do not come directly from the end-user.

ipAddressExtendedstring ipv4,ipv6

The end-user's public IP address. This only needs to be provided in situations where the HTTP requests do not come directly from the end-user.

externalUserIdstring

An identifier stored with the verification for external reference

captchaTokenstring

The captcha token collected for the person being verified

metadataPersonalInfoMetadata

A collection of custom metadata to be stored with the verification

Response

The result of the verification

Changes

No recorded changes to this endpoint across all 1 revision of this API.