Find Jobs

get

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

Return paginated jobs

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.

Allowed:

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.

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.

Responses

Language

Credentials

Header

Response

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

application/json; charset=utf-8

200Provide Results on Jobs.

400InvalidRequestError - The request is invalid.

401AuthenticationError - The request could not be authenticated.

404ConnectionError - A connection error occurred while communicating to the Vouched service.

429TooManyRequestsError - the Vouched service has throttled this request.

500UnknownSystemError - A unknown system error occurred.