Find Jobs

get

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

Return paginated jobs

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Filter by job ID.

internalId

string

Filter by internal ID set by your organization when the job was created.

type

string

enum

Filter by job type.

fields

string

Filter the fields returned. Separate multiple fields with commas. For nested fields, use dot notation.

ids

array of strings

Filter by a list of job IDs (e.g. GET /api/jobs?ids=AteDNdD&ids=jiorhBJDs).

ids

token

string

The time limited session token from the web client.

page

integer

≥ 1

Defaults to 1

Paginate list by page.

pageSize

integer

≤ 250

Defaults to 100

The number of items for a page.

sortBy

string

enum

Selection to sort list from.

Allowed:

sortOrder

string

enum

Order the sort.

Allowed:

status

string

enum

Filter by status.

Allowed:

aml

string

enum

Filter by AML match type.

Allowed:

from

string

Filter by submitted/updatedAt from the ISO8601 date.

string

Filter by submitted/updatedAt to the ISO8601 date.

toFrom

string

enum

Defaults to submitted

Filter to and from.

Allowed:

withPhotos

boolean

Job will contain idPhoto and userPhoto photos. Maximum 100 returned.

withPhotoUrls

boolean

Job will contain idPhotoUrl and userPhotoUrl signed. Maximum 100 returned.

signedUrl

boolean

Defaults to false

Include timed (15 min) signed photo urls on each job. Maximum 100 returned.

firstName

string

Filter by the verified first name. Matches case-insensitively from the start of the name.

lastName

string

Filter by the verified last name. Matches case-insensitively from the start of the name.

string

Filter by the submitted email address. Matches case-insensitively from the start of the address.

phone

string

Filter by the submitted phone number. Matches from the start of the number; dashes and spaces are ignored.

success

boolean

Filter by whether the verification succeeded.

accountReviewed

boolean

Filter by whether a reviewer on your account has marked the job as reviewed.

accountGroupSid

string

Filter by account group SID.

includeResults

boolean

Defaults to true

Include the result object on each job. Set to false for a substantially cheaper query.

withSession

boolean

true returns only jobs created through a web-client session; false returns only jobs submitted directly.

billable

boolean

true returns only billable jobs; false returns only jobs that never progressed past session initialization.

processed

boolean

Filter by whether the job finished processing.

billableType

string

enum

Return only jobs billable for the given feature.

aamvaSource

string

enum

Filter by the AAMVA source region.

Allowed:

respIdType

string

Filter by the detected id type of the verification result.

respIdState

string

Filter by the issuing state/province/territory of the verification result as a ISO 3166-2 code.

respIdCountry

string

Filter by the issuing country of the verification result as a ISO 3166-1 code.

respIdVersion

string

Filter by the detected id template version of the verification result.

Responses

200Provide Results on Jobs.

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.

500UnknownSystemError - A unknown system error occurred.