verification
package

Retrieve a package

Changed on
get/verification/{connection_id}/package/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/verification/{connection_id}/package/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Package

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

Response

Successful

idstring

Unique identifier for the verification type

created_atstring date-time

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

updated_atstring date-time

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

namestring required

Name of the verification type

type'IDENTITY_VERIFICATION' | 'SCREENING' | 'BACKGROUND_CHECK' | 'EMPLOYMENT_VERIFICATION' | 'EDUCATION_VERIFICATION' | 'CREDIT_CHECK' | 'FRAUD_PREVENTION' | 'OTHER' required
aliasesstring[]
tagsstring[]

Category (Verification, Validation, Background Check)

descriptionstring

Detailed description

has_redirect_urlboolean
has_target_urlboolean

where the provider will redirect the user to after the verification

needs_ip_addressboolean
cost_amountnumber

Cost-related information

currencystring
max_scorenumber

if this verification returns a score, what is the maximum?

info_urlstring

where to find additional information

valid_regionsstring[]

{country}-{state/province/territory} or just {country} 2-digit ISO codes

rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status