Skip to main content
GET
Get Document Verification

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Response

200 - application/json

Successfully retrieved document verification

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

object
enum<string>
required
Available options:
document_verification,
license_verification,
list
status
enum<string>
required
Available options:
scheduled,
processing,
completed,
failed
mode
enum<string>
required
Available options:
live,
test
scheduled_at
string<date-time>
required
started_at
string<date-time> | null
required
Example:

"2024-01-01T00:00:00Z"

completed_at
string<date-time> | null
required
Example:

"2024-01-01T00:00:00Z"

failed_at
string<date-time> | null
required
Example:

"2024-01-01T00:00:00Z"

external_id
string | null
required
Example:

"verification123"

document_id
string<uuid>
required
document_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
metadata
object | null
required
Example:
decision
enum<string>
required
Available options:
accepted,
rejected,
flagged,
failed
Example:

"accepted"

confidence
number | null
required
Required range: 0 <= x <= 100
Example:

90

issues
string[] | null
required
Pattern: ^[a-z0-9\s]+$
Example:
data
object | null
required
Example:
rules
object | null
required
Example: