Skip to main content

API Overview

Valydar is a REST API. All requests use JSON and require an API key.

Base URLs

EnvironmentBase URL
Sandboxhttps://api.dev.valydar.com
Productionhttps://api.valydar.com

Authentication

All requests require an API key in the Authorization: Bearer header:

-H "Authorization: Bearer YOUR_API_KEY"

Endpoints

Verifications

MethodEndpointDescription
POST/verificationsCreate a verification
GET/verifications/{id}Get verification status
GET/verificationsList verifications

Documents

MethodEndpointDescription
POST/verifications/{id}/documentsUpload a document

Biometrics

MethodEndpointDescription
POST/verifications/{id}/selfieUpload a selfie
POST/verifications/{id}/face-matchRun face match
POST/verifications/{id}/documents/{doc_id}/livenessRun document liveness
POST/verifications/{id}/active-liveness/challengeGenerate active liveness challenge
POST/verifications/{id}/active-liveness/verifyVerify active liveness

Admin

MethodEndpointDescription
GET/adminAdmin dashboard
GET/admin/keysList API keys
POST/admin/keysCreate API key
DELETE/admin/keys/{id}Revoke API key
PATCH/admin/webhookUpdate webhook URL
GET/admin/webhooks/deliveriesList webhook deliveries
POST/admin/webhooks/replayReplay webhook delivery

System

MethodEndpointDescription
GET/healthHealth check
GET/openapi.jsonOpenAPI spec
GET/docsAPI documentation

Response Format

All responses are JSON:

{
"id": "vry_a1b2c3d4e5f6",
"status": "pending",
"client_reference": "user_123",
"redirect_url": ""
}

Error Responses

{
"error": {
"code": "unauthorized",
"message": "The provided API key is invalid"
}
}
StatusErrorMeaning
400bad_requestInvalid request body
401unauthorizedMissing or invalid API key
403forbiddenInsufficient permissions
404not_foundResource doesn't exist
429rate_limit_exceededToo many requests
500internal_errorServer error