Skip to main content
POST
Start Document Verification (Deprecated)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A document verification to start

document
object
required
person
object
required
verification_type
enum<string>
required
Available options:
flu_vaccination,
resume,
tuberculosis_test,
covid_vaccination,
clipboard_health_badge,
physical_exam,
life_support_certification,
alcohol_handler_certification,
food_handler_certification
external_id
string
metadata
object
Example:
rules
object

Response

202 - application/json

Successfully started document verification

id
string
required
object
enum<string>
required
Available options:
verification
uri
string<uri>
required
Example:

"/verifications/123"

status
enum<string>
required
Available options:
scheduled,
processing,
complete,
failed
mode
enum<string>
required
Available options:
live,
test
verification_type
enum<string>
required
Available options:
flu_vaccination,
resume,
tuberculosis_test,
covid_vaccination,
clipboard_health_badge,
physical_exam,
life_support_certification,
alcohol_handler_certification,
food_handler_certification
created_at
string<date-time>
required
updated_at
string<date-time>
required
document_id
string<uuid>
required
Example:

"doc123"

person_id
string<uuid>
required
Example:

"person123"

external_id
string | null
required
Example:

"verification123"

metadata
object | null
required
Example: