Make an ID check link for a person (ID and Right to Rent together for a tenant in England).
The person must be a named individual set to be checked by link (idMethods: { "idv": "link" } with idv ticked, or for a tenant { "rightToRent": "link" } or { "rightToRent": "self", "tenantId": "link" }). Charged from credit when the link is made: £1.99 an ID check, £3.49 ID and Right to Rent; given back if it ends with nothing checked. Send startUrl to the person yourself: we do not email them. It names your firm (set it with PUT /v1/transactions/firm), then hands over to the identity service. A second call for the same person while a link is waiting returns that link (already: true) and charges nothing. A test key uses the identity service's sandbox: nothing charged, the link stays waiting.
Request
- Base URL: https://api.stratumapis.com
- URL: https://api.stratumapis.com/v1/transactions/{id}/digital-id
- Auth: API key in header X-Stratum-Key
Path parameters
The txnId from creating the transaction.
Response
The link is made.
Changes
No recorded changes to this operation across all 1 revision of this API.