get/v1/admin/applicant-users

Search the applicant directory

Operation: adminListApplicantUsers
Authentication: API key

Applicant accounts by name, address, phone, status or verification stage, newest first. The listing is audited — opening the directory is a logged event, because it is a list of people applying for a visa.

Request

Parameters

first_namequerystring

last_namequerystring

emailquerystring

phonequerystring

statusquerystring

verificationquerystring

from_datequerystring

to_datequerystring

limitqueryinteger

offsetqueryintegernull

Responses

200Applicant accounts and pagination totals.

Free-form JSON object.

400The request body or query failed validation.

errorobjectrequired

401No key, an unknown key, a revoked key, or a key whose tenant is not active. All four return an identical body on purpose: distinguishing them would let a caller discover which partners we have.

errorobjectrequired

403`projects:write` is required. No partner key is ever issued this scope.

errorobjectrequired

404Not found, or not yours. A resource belonging to another tenant answers 404 rather than 403, because 403 would confirm the record exists.

errorobjectrequired

Example

curl

curl -X GET https://api.haavisa.com/v1/admin/applicant-users \
  -H "Authorization: Bearer $HAAVISA_API_KEY"

More in Admin

Something unclear? The eligibility guide explains the model behind the answers; the errors guide covers the envelope.