Links

Fetch a link

Returns a link and, once the person finishes, its result.

GET/v1/kyc/links/{id}

Request

Authenticate with Authorization: Bearer <your key>.

Path parameters

idstringrequired
lnk_ for ID number links, vlk_ for face links.

Example

GET /v1/kyc/links/{id}

curl https://api.verath.io/v1/kyc/links/lnk_5b0c2e7d9a1f4e3c8b6a2d1e0f9c8b7a \
  -H "Authorization: Bearer $VERATH_KEY"

200 OK

{
  "id": "lnk_5b0c2e7d9a1f4e3c8b6a2d1e0f9c8b7a",
  "object": "link",
  "kind": "match",
  "steps": [
    "id_number"
  ],
  "mode": "test",
  "check": "nin_basic",
  "purpose": "KYC-ONB",
  "customer_ref": "cust_1042",
  "name": "Ngozi",
  "status": "pending",
  "attempts": 0,
  "opened_at": null,
  "completed_at": null,
  "expires_at": "2026-11-18T15:32:00.000Z",
  "created_at": "2026-11-11T15:32:00.000Z",
  "result": null
}

Responses

Status	Meaning
200	The link.
404	No such link.