Retrieve a package

Updated:

GET/verification/{connection_id}/package/{id}

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
idstring required
ID of the Package

Returns

Response fieldTypeRequiredDescription
idstringNoUnique identifier for the verification type
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringYesName of the verification type
typeenumYesValues: IDENTITY_VERIFICATION, SCREENING, BACKGROUND_CHECK, EMPLOYMENT_VERIFICATION, EDUCATION_VERIFICATION, CREDIT_CHECK, FRAUD_PREVENTION, OTHER
aliasesstring[]No
tagsstring[]NoCategory (Verification, Validation, Background Check)
descriptionstringNoDetailed description
parametersVerificationParameter[]NoQuestions that need to be answered for this verification
parameters[].idstringNo
parameters[].namestringYes
parameters[].public_questionstringNoquestion to ask the human
parameters[].typeenumNoValues: TEXT, NUMBER, MULTIPLE_CHOICE, MULTIPLE_SELECT, DATE, FILE
parameters[].optionsstring[]Nooptions for MULTIPLE_CHOICE and MULTIPLE_SELECT
parameters[].file_typesstring[]Novalid file mime types
parameters[].valid_regionsstring[]No{country}-{stateprovince/territory} or just {country} 2-digit ISO codes
parameters[].is_requiredbooleanNo
average_processing_timesVerificationTime[]Noaverage processing time in minutes
average_processing_times[].millisecondsnumberNo
average_processing_times[].valid_regionsstring[]No{country}-{stateprovince/territory} or just {country} 2-digit ISO codes
has_redirect_urlbooleanNo
has_target_urlbooleanNowhere the provider will redirect the user to after the verification
needs_ip_addressbooleanNo
cost_amountnumberNoCost-related information
currencystringNo
max_scorenumberNoif this verification returns a score, what is the maximum?
info_urlstringNowhere to find additional information
valid_regionsstring[]No{country}-{state/province/territory} or just {country} 2-digit ISO codes

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"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot 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: 'GET',
  url: 'https://api.unified.to/verification/5de520f96e439b002043d8dc/package/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?