Skip to main content

Applicant

Person being verified on an order: identity, optional contact details, addresses, and aliases.

Fields

addresses is optional on order creation. See Create order — field reference for the full request contract.

Signed release file

signedReleaseFileUrl is optional. When provided, the signed release PDF is attached to outbound verification requests (email or fax, depending on organization policy). You can supply the file in three ways:
Inline base64 must decode to a valid PDF (starts with %PDF) and must not exceed 10MB. Production accepts HTTPS URLs only (not http://).
  1. GET /files/release-form/generate-upload-urlsignedUrl, fileUri
  2. PUT the PDF to signedUrl with Content-Type: application/pdf
  3. Set applicant.signedReleaseFileUrl to fileUri

Inline base64 example

Example

Validation rules

  • SSN: Required non-empty string. Conventionally XXX-XX-XXXX; format validation is not enforced.
  • Email Format: Must be a valid email address when provided
  • Date Format: All dates must be in YYYY-MM-DD format
  • Address Requirement: When addresses is non-empty, exactly one address must be current (endDate: null or omitted). Omit addresses or send [] when you do not need home address history.
  • Signed release file: Must be a valid HTTPS URL (production), GCS URI (gs://), or base64-encoded PDF (max 10MB). Inline base64 is uploaded to cloud storage at order creation; searches store the resulting gs:// URI.