verification

Submit first responder 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/collectFirstResponderPersonalInfo

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

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

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

status'POLICE' | 'EMT' | 'FIREFIGHTER' | 'SEARCH_AND_RESCUE'

statusesFirstResponderStatus[]

A list of the first responder statuses. You must supply this field, or the deprecated status field, which holds only one value. If you supply no status, the server rejects the request with the invalidFirstResponderStatus error.

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

postalCodestring

The postal code for the person being verified. Provide when open org is submitted, i.e. organization id = 0

stateCodestring

The two character state code for the person being verified. Provide when open org is submitted, i.e. organization id = 0

countrystring nullable

The two character country code for the person being verified. May be null when not yet determined.

Response

The result of the verification

Changes

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