Starts payment for a request where the candidate, rather than your organisation, is paying.
Returns an authorization URL to redirect the candidate to. The request stays in pending_payment until the gateway confirms.
Authorization
ApiKeyAuth In: header
Path Parameters
Candidate request reference, returned as reference when the request was created.
uuidTypeScript Definitions
Use the request body type in TypeScript.
Serializer for payment initialization.
Response Body
application/json
curl -X POST "https://example.com/api/v1/api/bgc/requests/candidates/497f6eca-6276-4993-bfeb-53cbbbba6f08/initiate-payment/" \ -H "Content-Type: application/json" \ -d '{ "reference": "string" }'{ "data": {}, "status": true, "message": "Request successful.", "errors": {}, "meta": { "timestamp": "2019-08-24T14:15:22Z", "version": "v1", "request_id": "string" }, "pagination": { "page": 0, "page_size": 0, "total_pages": 0, "total_items": 0 }}response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.
Join Slack ChannelVerify candidate payment GET
Confirms a candidate payment with the gateway and, once confirmed, submits the request to the verification provider. **This both verifies and advances the request** — it is the completion step of the candidate-paid flow, not a read-only status check. To read payment state without side effects, fetch the candidate request instead.
Get report customization GET
Returns how your organisation's background check reports are branded and laid out. Defaults are returned when you have never saved any.