---
title: "Update a request"
method: PATCH
path: "/verification/{connection_id}/request/{id}"
tags: ["verification", "request"]
---

# Update a request

`PATCH /verification/{connection_id}/request/{id}`

## Request

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

## Path parameters

- `connection_id` string, required
- `id` string, required

## Query parameters

- `fields` string[]
- `raw` string

## Request body

- VerificationRequest
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `package_id` string
  - `parameters` VerificationParameterInput[]
    - `id` string
    - `name` string: name of parameter
    - `inputs` string[]
  - `target_url` string
  - `candidate_id` string: points to ATS Candidate
  - `profile_ip_address` string: XXX.XXX.XXX.XXX
  - `profile_name` string
  - `profile_date_of_birth` string: YYYY-MM-DD
  - `profile_addresses` VerificationAddress[]
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string: 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.
    - `region_code` string: 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.
    - `postal_code` string
    - `country` string
    - `country_code` string: Country code for the country, in ISO 3166 A-2 format
  - `profile_gender` 'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
  - `profile_emails` string[]
  - `profile_telephones` string[]
  - `profile_national_identifier` string
  - `response_completed_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `response_expires_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `response_issued_at` string, 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_score` number: 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: 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[]: report download
  - `response_details` VerificationResponseDetail[]
    - `title` string
    - `text` string
    - `is_private` boolean
    - `is_failed_reason` boolean
    - `parameter_id` string: in reference to the parameter input
    - `download_url` string
  - `response_source` string
  - `metadata` VerificationMetadata[]
    - `id` string
    - `slug` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
  - `raw` unknown

## Response `200`

Successful

- VerificationRequest
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `package_id` string
  - `parameters` VerificationParameterInput[]
    - `id` string
    - `name` string: name of parameter
    - `inputs` string[]
  - `target_url` string
  - `candidate_id` string: points to ATS Candidate
  - `profile_ip_address` string: XXX.XXX.XXX.XXX
  - `profile_name` string
  - `profile_date_of_birth` string: YYYY-MM-DD
  - `profile_addresses` VerificationAddress[]
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string: 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.
    - `region_code` string: 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.
    - `postal_code` string
    - `country` string
    - `country_code` string: Country code for the country, in ISO 3166 A-2 format
  - `profile_gender` 'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
  - `profile_emails` string[]
  - `profile_telephones` string[]
  - `profile_national_identifier` string
  - `response_completed_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `response_expires_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `response_issued_at` string, 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_score` number: 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: 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[]: report download
  - `response_details` VerificationResponseDetail[]
    - `title` string
    - `text` string
    - `is_private` boolean
    - `is_failed_reason` boolean
    - `parameter_id` string: in reference to the parameter input
    - `download_url` string
  - `response_source` string
  - `metadata` VerificationMetadata[]
    - `id` string
    - `slug` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
  - `raw` unknown

---

[API](https://skmtc.dev/unified/apis/unified-to-api-2.md) · [All operations](https://skmtc.dev/unified/apis/unified-to-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api-2/revisions/7a38bdd7f089?raw)