Developers
V1PlatformMerchantsIdVerification

Record what was checked: SSM verified, clinic licence number, issuing body and expiry

Identifiers only; no document is stored. Needs the merchants Manage permission and a fresh password or email-code session. Enter the licence number, issuing body and expiry date together or leave all three empty. verifiedBy and verifiedAt are set by the server from the signed-in administrator. 409 merchant_verification_changed when expectedVersion is out of date (0 for the first record).

PATCH
/v1/platform/merchants/{id}/verification

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/platform/merchants/497f6eca-6276-4993-bfeb-53cbbbba6f08/verification" \  -H "Content-Type: application/json" \  -d '{    "expectedVersion": 0,    "ssmVerified": true,    "clinicLicenceNumber": "string",    "licenceIssuingBody": "string",    "licenceExpiresOn": "2019-08-24"  }'
{  "verification": {    "ssmVerified": true,    "clinicLicenceNumber": "string",    "licenceIssuingBody": "string",    "licenceExpiresOn": "2019-08-24",    "verifiedBy": "string",    "verifiedAt": "2019-08-24T14:15:22Z",    "version": 0  }}

Platform: one merchant's progress from invitation to first redemption, with their vouchers GET

Invite accepted, listing live, vouchers live, scanner link, first claim and first redemption, each with a time when done; and every voucher with its branches, eligibility, status and counts. Counts only.

Platform admin: list booth scan links GET

Status, expiry, outlet and device counts. No token or PIN is ever returned again after creation.