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.
Authorization
ApiKeyAuth In: header
Path Parameters
Candidate request reference.
uuidPayment reference issued by the gateway.
Response Body
application/json
curl -X GET "https://example.com/api/v1/api/bgc/candidate-payment-verify/497f6eca-6276-4993-bfeb-53cbbbba6f08/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 ChannelGet a system package GET
Returns one predefined package, including the check types it bundles. Only active system packages are visible here; your own packages are served by the package endpoints.
Initialize candidate payment POST
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.