Skip to main content

Quickstart

Get up and running with Valydar in 5 minutes.

Prerequisites​

  • A Valydar account and API key — see Billing & Plans. Free and certified-NGO accounts create keys without a card; paid plans require a payment method first.
  • cURL, Postman, or any HTTP client
  • A test document image (passport, ID card, or driver's license)

Step 1: Create a verification​

curl -X POST https://api.dev.valydar.com/verifications \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"client_reference": "order-1234", "checks": ["document"]}'

client_reference is your own identifier for the run (returned to you in webhooks). checks lists the verification steps to run (e.g. document, identity, aml, face_match, nfc, deepfake).

Response (201):

{
  "id": "vry_3f2a...",
  "client_reference": "order-1234",
  "status": "pending",
  "redirect_url": null
}

Save the id — you'll need it for all subsequent requests.

Step 2: Upload a document​

curl -X POST https://api.dev.valydar.com/verifications/{id}/documents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "document_type=passport" \
  -F "file=@passport.jpg"

document_type is required: passport, national_id, drivers_license, or residence_permit.

Response:

{
  "document_id": "doc_abc123",
  "type": "passport",
  "status": "completed",
  "mrz": {
    "document_type": "passport",
    "issuing_state": "NLD",
    "name": "JOHN DOE",
    "dob": "1990-01-15",
    "document_number": "SPECIMEN123"
  }
}

Step 3: Get results​

curl https://api.dev.valydar.com/verifications/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "id": "vry_3f2a...",
  "client_reference": "order-1234",
  "status": "completed",
  "checks_results": {
    "document": {
      "passed": true,
      "details": {
        "document_type": "passport",
        "name": "JOHN DOE",
        "dob": "1990-01-15",
        "nationality": "NLD"
      }
    }
  },
  "created_at": "2024-01-15T10:30:00Z",
  "completed_at": "2024-01-15T10:30:05Z"
}

Using the SDK​

<script src="https://portal.valydar.com/sdk/valydar.js"></script>
<script>
  const client = Valydar.create({ apiKey: 'YOUR_API_KEY' });

  const verification = await client.createVerification();
  await client.uploadDocument(verification.id, fileInput.files[0]);
  const result = await client.waitForCompletion(verification.id, 30000);
  console.log(result);
</script>

Next Steps​