Create a request
POST/verification/{connection_id}/request
Parameters
fieldsstring array
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
connection_idstring required
ID of the connection
Payload
idstring read-only
created_atdate-time read-only
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time read-only
(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 enum
Valid values:
"MALE"
"FEMALE"
"INTERSEX"
"TRANS"
"NON_BINARY"
profile_emailsstring array
profile_telephonesstring array
profile_national_identifierstring
response_completed_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_expires_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_issued_atdate-time
datetime that identify was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response_status enum
Valid values:
"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 array
report download
response_sourcestring
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | (read-only) |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only) |
package_id | string | No | |
parameters | VerificationParameterInput[] | No | |
parameters[].id | string | No | |
parameters[].name | string | No | name of parameter |
parameters[].inputs | string[] | No | |
target_url | string | No | |
candidate_id | string | No | points to ATS Candidate |
profile_ip_address | string | No | XXX.XXX.XXX.XXX |
profile_name | string | No | |
profile_date_of_birth | string | No | YYYY-MM-DD |
profile_addresses | VerificationAddress[] | No | |
profile_addresses[].address1 | string | No | |
profile_addresses[].address2 | string | No | |
profile_addresses[].city | string | No | |
profile_addresses[].region | string | No | Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province. |
profile_addresses[].region_code | string | No | Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province. |
profile_addresses[].postal_code | string | No | |
profile_addresses[].country | string | No | |
profile_addresses[].country_code | string | No | Country code for the country, in ISO 3166 A-2 format |
profile_gender | enum | No | Values: MALE, FEMALE, INTERSEX, TRANS, NON_BINARY |
profile_emails | string[] | No | |
profile_telephones | string[] | No | |
profile_national_identifier | string | No | |
response_completed_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
response_expires_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
response_issued_at | string (date-time) | No | datetime that identify was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
response_status | enum | No | Background checks and compliance checks return CLEARFLAGGED or PASS/FAIL or YES/NO Values: COMPLETED, FAILED, PASSED, PENDING |
response_score | number | No | 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_url | string | No | 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_urls | string[] | No | report download |
response_details | VerificationResponseDetail[] | No | |
response_details[].title | string | No | |
response_details[].text | string | No | |
response_details[].is_private | boolean | No | |
response_details[].is_failed_reason | boolean | No | |
response_details[].parameter_id | string | No | in reference to the parameter input |
response_details[].download_url | string | No | |
response_source | string | No |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'POST',
url: 'https://api.unified.to/verification/5de520f96e439b002043d8dc/request',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know