v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB

verification

request

Create a request

post/verification/{connection_id}/request

Path parameters

connection_idstring required

ID of the connection

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring

created_atstring date-time

updated_atstring date-time

package_idstring

target_urlstring

candidate_idstring

profile_ip_addressstring

profile_namestring

profile_date_of_birthstring

profile_gender'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'

profile_emailsstring[]

profile_telephonesstring[]

profile_national_identifierstring

response_completed_atstring date-time

response_expires_atstring date-time

response_issued_atstring date-time

response_status'COMPLETED' | 'FAILED' | 'PASSED' | 'PENDING'

response_scorenumber

response_redirect_urlstring

response_download_urlsstring[]

report download

response_sourcestring

rawobject

Response

Successful