Check the status of the Nafath service call associated with a previously initiated request
This is a draft version of the SME Onboarding APIs. The final version is expected to be released by the end of September. The API specifications are subjected to go through a few more changes before the final version is released.
Nafath Call Status API allows you to verify whether the request to the Nafath service was successfully processed by the bank.
Use this API after the customer validation and before proceeding with the Nafath initiation flow.
Environment | Domain | Rate/Limit |
|---|---|---|
Sandbox | 3 Calls per Minute | |
Production/LIVE | To be provided upon onboarding | Based on contract |
Endpoint | Method | Authentication requirements |
|---|---|---|
| POST | Header
Request body
|
curl --location 'https://sandboxapi.onesingleview.com/api/v2/smeonboarding/nafathcallstatus' \
--header 'SVReferenceID: SV123456' \
--header 'CompanyId: SINGLEVIEW1234' \
--header 'Device: web' \
--header 'DateTimeStamp: 2025-01-07T10:20:39' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNeVN4WFRCZjlqUlNWQzFad3B5QnlkOVpHelZXR2ZwUmFQNUUrY3d6cVQ5bi9OV0lwR2V5STNNMkdPL1pqakd4ZG0yclJkVEZxY3lhWGNpWnZFejl0V1EySjQxK2VvSlk2ZjdJZkFsV3BKRi9VL1YydDEzMUtnRnVhcnd6MzVQY1UzbnFEV0p0UWlzIiwiaWF0IjoxNzY3NzYxODc3LCJleHAiOjE3Njc3NjU0Nzd9.lWDSB3Rk_TtdUbKyFcCdaE5XGo7UDiTu2kDcqEyU7vg' \
--header 'Content-Type: application/json' \
--data '{
"Message": {
"NafathCallStatusRequest": {
"ReferenceNumber": "123456789"
}
},
"Signature": "rZZ9alg/2k9B5uWSdnW3AfYswAMqA4HXyNX3jIzckWb4o37uS4eKFEQ3xRn/dBarN6EGjfaXiMSOPdKyyjjrgT80K5ReXzQ7cC1INuU79ozlLgK8yTFz+nq785geQ+He4PR+hD35DkF9qnela9qmcr3GhAXpTjZG12hmaJEyzeofh6q3p+jqLFd208eAImubnL6SbSBDEAi5SLRH1K2I1U77OmFNirrfGV8qd+gsi+lqgyF9mpNj6lzy/fJNNe0qEr2WHvG1R7E2g3EhqovDNanQt6RFgkWegtlE37Eyi5qO3xlTqu76317ZWfMI7jHxs48fOLTNtBCOwUboVze5Tw=="
}'Request parameters
JSON Tag | Requirement | Description | Data type |
|---|---|---|---|
NafathCallStatusRequest | Mandatory | Root node containing information to request to manage customer information | Object |
ReferenceNumber | Mandatory | Reference number associated with the Nafath service call whose status needs to be checked obtained in Manage user response | String |
{
"NafathCallStatusResponse": {
"StatusCode": "Completed",
"StatusDetail": "Call status successful.",
"ReferenceNumber": "23341800",
"TimeStamp": "2026-08-27T07:22:16"
}
}Response parameters
JSON Tag | Description | Data type |
|---|---|---|
NafathCallStatusResponse | Root node containing information of response for Nafath call status | Object |
StatusCode | Code representing status of the transaction in the request | String |
StatusDetail | Details of the status code represented for the transaction in the request | String |
ReferenceNumber | Reference number generated for the request | String |
TimeStamp | Date and time when the response was generated | String |
StatusCode | StatusDetail |
|---|---|
Completed | Call status successful. |
Failed | Bank response description |
Response_Timeout | Timeout! Unable to get response from the bank. Please try again or contact SingleView support if issue persists. |