verification
request

Create a request

post/verification/{connection_id}/request

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/verification/{connection_id}/request
  • Auth: API key in header authorization

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

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

package_idstring
target_urlstring
candidate_idstring

points to ATS Candidate

profile_ip_addressstring

XXX.XXX.XXX.XXX

profile_namestring
profile_date_of_birthstring

YYYY-MM-DD

profile_gender'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
profile_emailsstring[]
profile_telephonesstring[]
profile_national_identifierstring
response_completed_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

response_expires_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

response_issued_atstring date-time

datetime that identify was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

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

Background checks and compliance checks return CLEARFLAGGED or PASS/FAIL or YES/NO

response_scorenumber

Identity verification services provide confidence scores (e.g., 0-100), Credit checks return specific numeric scores (e.g., FICO score 300-850), Fraud prevention tools use risk scores (e.g., 1-999)

response_redirect_urlstring

Most modern IDV providers (like Onfido, Veriff, Jumio, ID.me). Background Check Providers, such as Checkr, GoodHire, Sterling, and HireRight. Credit bureaus and services often require direct user consent and information. This allows them to properly handle disclosures required by regulations like FCRA. Employment and Education Verification need users to confirm previous employers and schools.

response_download_urlsstring[]

report download

response_sourcestring
rawunknown

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

package_idstring
target_urlstring
candidate_idstring

points to ATS Candidate

profile_ip_addressstring

XXX.XXX.XXX.XXX

profile_namestring
profile_date_of_birthstring

YYYY-MM-DD

profile_gender'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
profile_emailsstring[]
profile_telephonesstring[]
profile_national_identifierstring
response_completed_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

response_expires_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

response_issued_atstring date-time

datetime that identify was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

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

Background checks and compliance checks return CLEARFLAGGED or PASS/FAIL or YES/NO

response_scorenumber

Identity verification services provide confidence scores (e.g., 0-100), Credit checks return specific numeric scores (e.g., FICO score 300-850), Fraud prevention tools use risk scores (e.g., 1-999)

response_redirect_urlstring

Most modern IDV providers (like Onfido, Veriff, Jumio, ID.me). Background Check Providers, such as Checkr, GoodHire, Sterling, and HireRight. Credit bureaus and services often require direct user consent and information. This allows them to properly handle disclosures required by regulations like FCRA. Employment and Education Verification need users to confirm previous employers and schools.

response_download_urlsstring[]

report download

response_sourcestring
rawunknown

Changes

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