Address Verification API

A REST API for UAE residential address verification. Submit an individual and an address; receive a deterministic High, Medium, or Low assurance outcome. Responses never include the underlying source or address data.

Introduction

Address Verification API

The WAYN API verifies a UAE residential address for an individual you already hold on file. You submit the individual and the address; WAYN assesses them against authoritative UAE address records and returns an assurance level of high, medium or low, together with a recommended next step. Where confidence is low, a WAYN field verifier can confirm residence in person, after which the verification carries the wayn_verified status.

The API is organised around a single resource, the address verification. It is served over HTTPS, versioned in the path, accepts and returns JSON, and uses conventional HTTP status codes. Field names are snake_case.

Base URL

https://wayn-verify.vercel.app/v1

This environment accepts sandbox keys (wayn_sk_test_). Production endpoints and live keys are issued by WAYN during onboarding.

Conventions

Media type: Requests and responses use application/json. Errors use application/problem+json.
Versioning: The API version is part of the path. The current version is v1. Breaking changes are released under a new version.
Request ids: Every response, including errors, carries a WAYN-Request-Id header for correlation and support.
Timestamps: ISO 8601 in UTC, for example 2026-10-05T10:12:04.000Z.
Identifiers: Prefixed by type: avr_ for verifications, evt_ for events, req_ for request ids.

Data returned

Responses contain the assurance outcome and, where earned, the WAYN Verified status. They never contain the underlying source records, raw record values, source systems, the internal checks that produced the level, or an echo of the submitted address. Emirates ID values are returned masked.

Create a verification

curl -X POST https://wayn-verify.vercel.app/v1/address-verifications \
  -H "Authorization: Bearer wayn_sk_test_9k2m4p8q1r3s5t7v0w2x4y" \
  -H "Content-Type: application/json" \
  -d '{
    "client_reference": "CASE-10482",
    "identity": { "full_name": "Ahmed Khalid Al Falasi", "phone": "+971501234567" },
    "address": { "emirate": "Dubai", "area": "Dubai Marina", "building_name": "Marina Gate 2", "unit": "1204" }
  }'

201 Created

{
  "id": "avr_7Q2m9K4xB1",
  "object": "address_verification",
  "reference": "WYN-26-0AF3C1",
  "status": "assessed",
  "assurance_level": "high",
  "wayn_verified": false,
  "result": {
    "address_supported": true,
    "summary": "The submitted address is consistent with available authoritative records. No further verification is required under current policy.",
    "recommended_action": "none"
  },
  "client_reference": "CASE-10482",
  "mode": "test",
  "channel": "api",
  "created": "2026-10-05T10:12:04.000Z"
}