Update Job Review

put

https://verify.vouched.id/api/jobs/{id}/review

Update Job Review

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The job ID.

Body Params

idValid

boolean

Is the id valid.

selfieValid

boolean

Is the selfie valid.

faceMatch

boolean

Is the face match valid.

birthDateMatch

boolean

Does the birthdate match.

nameMatch

boolean

Does the name match.

firstName

string

The first name.

lastName

string

The last name.

docId

string

The document id number.

idType

document_type | null

The id type.

birthDate

string | null

The date of birth.

expireDate

string | null

The id expiration date.

issueDate

string | null

The id issue date. Persisted, but not echoed back in the response review object.

state

string

The state/province/territory ISO 3166-2 code.

country

string

The country ISO 3166-1 code.

dlvValid

boolean

Reviewer override for the DLV check. Mirrors the other per-field overrides (idValid, selfieValid, …) and lets a reviewer approve a job that was rejected by DLV. false participates in the reviewSuccess calculation as a rejection; true (or null) does not. The original Vouched decision (result.success) is preserved.

barcodeMatch

boolean

Reviewer override for the barcode reconciliation check — whether the data read from the back barcode matches the data read off the front of the ID. Mirrors the other per-field overrides and lets a reviewer approve a job that was rejected for a barcode mismatch. false participates in the reviewSuccess calculation as a rejection; true (or null) does not. The original Vouched decision (result.success) is preserved.

reviewSuccess

boolean | null

The reviewer's decision for the job as a whole: true approves it, false rejects it. It takes precedence over every per-field override, so a job can be approved or rejected whatever check produced the Vouched outcome, including rejections with no per-field override (for example an expired ID). A job accepts at most two job-level decisions; a third returns 409. Once a job has a job-level decision, a review without reviewSuccess set to true or false also returns 409. The original Vouched decision (result.success) is preserved, and a decision triggers the job-review webhook.

note

string | null

Free-text note the reviewer left with the review. Trimmed; an empty string is stored as null. Returned in the job's review object and included in the job-review webhook payload.

Responses

200Update Review of a Job

400InvalidRequestError - The request is invalid. An aborted or oversized request is answered with this status and an empty body instead of the envelope below.

401The request could not be authenticated. Credential rejection returns an AuthenticationError envelope; a malformed or expired bearer token is rejected earlier by the JWT middleware and returns { "error": "Token expired" } or { "error": "Token malformed" } instead.

404NotFoundError - The requested resource does not exist.

409ConflictError - The request conflicts with the current state of the resource.

500UnknownSystemError - A unknown system error occurred.