Tenant API

Start a verification from your own systems, and read what it decided.

The Tenant API is how an institution's own systems drive onboarding. It has two halves behind one credential: open a hosted verification and let a customer walk it, or call a single verification service directly and handle the rest yourself.

The shortest path to a working integration

  • Ask your administrator for an API credential from the API Credentials screen. Start with a Sandbox one.
  • Call GET /me. It tells you what your credential can actually do, which saves guessing later.
  • Call GET /workflows to find the journey you want, and GET /workflows/{workFlowId} to see the fields it collects.
  • Call POST /sessions with that work flow. Send your customer the verificationUrl it returns.
  • Poll GET /cases to discover when anything has been decided, then read the decision.
curl
curl https://api.example.com/api/v1/integration/me \
  -H "X-API-Key: pmt_test_..."

Two things to know before you start

Base address and versioning

Every operation lives under /api/v1/integration. The version is in the path and will change only for a breaking change; new fields and new endpoints appear within v1, so tolerate fields you do not recognise.