The Partner Retail Account Application API is available to partner institutions to initiate the basic account opening process for their new retail customers and to update KYC details of the customer once document verification is completed from their end. The scanned documents need to be uploaded separately to a SFTP server. Post verification of the documents by the RAKBank operations and compliance teams, the customer onboarding and account opening would be completed and the status would be notified to the partner. At every stage, the status of the application will be notified to the client using this API.
The notifications would be sent at three stages as mentioned below. Stage 2 is optional and may apply only to certain individuals where additional details or documents are required by the Bank's Compliance team to process the application.
- Stage 1 : Initial verification when the application is first created with basic details.
- Stage 2 : Request for additional Know Your Customer (KYC) details/documents of the customer.
- Stage 3 : After final processing with REJECTED or PROCESSED_SUCCESSFULLY status.
The partner is expected to host the notification API on their server as per the documentation provided here.
Version 1.1.0
- status field can also have value "ADDITIONAL_COMPLIANCE_INFO_REQ" - indicating that additional document/info of the customer is required by RAKBank compliance team. Remarks field will have details of the additional info requested.
- remarks field will be mandatory when status is 'ADDITIONAL_COMPLIANCE_INFO_REQ'
Basepath
/v1
Paths
/retail/account_applications/{application_id}/application_status
This is used by RAKBANK to update the Partner about the status of a Retail Account application during different stages of the customer onboarding process.
Unique identifier of the request.
{
"maxLength": 50
}
Application Id of the application that was submitted earlier.
{
"maxLength": 30
}
status of the application
Definitions
Response in case of error
{
"properties": {
"response_code": {
"type": "string",
"description": "API specific error code"
},
"response_message": {
"type": "string",
"description": "brief details of the error"
},
"status": {
"type": "string",
"description": "HTTP Status or Request Status"
},
"description": {
"type": "string",
"description": "detailed description of the error"
},
"property": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"response_code",
"response_message",
"status"
]
}
Status object
{
"properties": {
"status": {
"type": "string",
"enum": [
"INITIAL_VERIFICATION_SUCCESSFUL",
"REJECTED_AT_INITIAL_VERIFICATION",
"PROCESSED_SUCCESSFULLY",
"REJECTED",
"ADDITIONAL_COMPLIANCE_INFO_REQ"
],
"description": "Status to be updated. Valid values:\n- INITIAL_VERIFICATION_SUCCESSFUL - indicating intial verification is successful,\n- REJECTED_AT_INITIAL_VERIFICATION - Rejected at Initial Verification stage,\n- PROCESSED_SUCCESSFULLY -indicating the application was successfully processed i.e. Retail Account opening was successful,\n- REJECTED - indicating that the application was rejected at final stage,\n- ADDITIONAL_COMPLIANCE_INFO_REQ - indicating that additional document or details of the customer is required by RAKBank compliance team. Remarks field will have details of the additional info requested.\n",
"example": "PROCESSED_SUCCESSFULLY"
},
"reject_code": {
"type": "string",
"maxLength": 10,
"description": "Rejection code"
},
"reject_reason": {
"type": "string",
"maxLength": 150,
"description": "Reason for rejection"
},
"remarks": {
"type": "string",
"maxLength": 3000,
"description": "Operation Personnel Remarks. Mandatory when status is 'ADDITIONAL_COMPLIANCE_INFO_REQ'"
}
},
"additionalProperties": false,
"required": [
"status"
]
}