Skip to content

Quickstart — KYC / KYB

From environment access to a first successful identity check.

Prerequisites

  1. Environment access and any gateway rules — Base URLs / Access onboarding.
  2. A stable test userId (UUID).
  3. Test identity data approved for non-production use.

Steps

  1. GET {kyc_base}/health → expect 200.
  2. POST {kyc_base}/prembly_id_check with JSON including userId and the ID fields required by OpenAPI.
  3. Inspect the response for vendor verification fields (exact shape in OpenAPI).

Call from your backend, not a browser.

Observable success

Signal Meaning
HTTP 200 with a structured verification payload Check executed (vendor-dependent content)
Persisted row keyed by your userId (if your programme stores results) Downstream storage accepted

Vendor “no match” can still be HTTP 200 with a negative verification outcome — read the body, not only the status.

If it fails

Timeouts / 5xx → treat as uncertain; see retry. Auth failures depend on your environment’s gateway (not Fraud ApiKey).

Next: KYC examples · KYC API