Submit Job

post

https://verify.vouched.id/api/jobs

Submit a verification job.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Note this body is not validated against a schema — the handler reads it directly, so unknown fields are accepted rather than rejected. Only type is enforced, by an explicit check.

type

string

enum

required

Type of verification job.

Allowed:

stage

string

enum

Which step of a multi-step capture flow this submission represents. Omitting it is equivalent to id for an id-verification job. It also governs whether params.idPhoto / params.userPhoto are required — see params.

callbackURL

string

Upon the job's completion, Vouched will POST the job results to the defined webhook.

accountGroupSid

string

Assign the job to an account group.

properties

array of objects

List of arbitrary customer supplied properties

properties

params

object

Optional. Defaults to an empty object. Required in practice for the capture stages that need a photo — see the conditional rules on idPhoto and userPhoto.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Running a Job through Vouched.

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.

500UnknownSystemError - A unknown system error occurred.