v1

latestOpenAPI 3.1.0Apache 2.02026-07-24196597.7 KB
jobs

Find Jobs

Return paginated jobs

get/api/jobs

Query parameters

idstring

Filter by job ID.

internalIdstring

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

type'id-verification'

Filter by job type.

fieldsstring

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

idsstring[]

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

tokenstring

The time limited session token from the web client.

pageinteger

Paginate list by page.

pageSizeinteger

The number of items for a page.

sortBy'submitted' | 'updated' | 'status'

Selection to sort list from.

sortOrder'asc' | 'desc'

Order the sort.

status'active' | 'completed' | 'removed'

Filter by status.

aml'sanction' | 'warning' | 'pep' | 'all'

Filter by AML match type.

fromstring

Filter by submitted/updatedAt from the ISO8601 date.

tostring

Filter by submitted/updatedAt to the ISO8601 date.

toFrom'submitted' | 'updatedAt'

Filter to and from.

withPhotosboolean

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

withPhotoUrlsboolean

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

Response

Provide Results on Jobs.