[Go to site: main page, start]

KYC callback


Description

This is a callback to notify partners BE-BE about the KYC process completion. The endpoint is to be implemented by the partner where we can send the callback as per the contract mentioned.

Host

To be provided by partner

Endpoint

/v1/callback/partner

Method

PUT


Headers

Header KeyDescriptionExample
AuthorizationLinking token received after login step
Content-TypeStandard HTTP content-type headerapplication/json

Request payload

{
  "submissionId": "submission-uuid",
  "partnerSessionId": "<submission.partnerSessionId>",
  "status": "COMPLETED",   
  "result": "VALID",  
  "reasonCode": null      
}
FieldDescriptionExample
submissionIdIf multiple submissions are made for the same partnerSessionId, this field uniquely identifies a submission. Currently, the use case suggested is for debugging purposes only.
partnerSessionIdrequest-id from the start of the Gopay ID process
statusIdentifies whether the KYC process successfully completed or met a technical errorCOMPLETED|ERROR
resultIdentifies whether the KYC is approved, rejected VALID|INVALID
reasonCodeFor the following combinations, this field identifies the cause of the same.
  • status = COMPLETED, result = INVALID
  • status = ERROR, result = null



Did this page help you?