Open BankingB2B SuiteERP Integration
GuidesAPI ReferenceChangelog
Menu

Categories

Open BankingB2B SuiteERP Integration

  • GENERAL INFORMATION

    • Documentation guide
    • SingleView B2B Core APIs
    • Platform architecture
  • GETTING STARTED

    • Integration guide
    • Become a user
    • Prerequisites for Sandbox
    • Establishing secure connection
    • Authenticating your request
    • Making your first test api call
    • Prerequisites for production
    • Moving to production
  • AUTHENTICATION

    • Header parameters
    • Obtain access token
    • Generate signature
  • Data APIs

    • Account statement
    • Balance enquiry
    • IBAN verification
    • POS transactions
    • Raw statement
  • Payment APIs

  • SADAD

  • Virtual Accounts

    • Overview
    • Create new virtual account
    • Block/Unblock virtual account
    • VA balance enquiry
    • VA statement
  • SME Onboarding (Draft)

    • Overview (Draft)
  • RESOURCES

    • User inputs
    • POR Details
    • Error codes
  • API Archives


Nafath verification status

Check the current status of a customer's Nafath identity verification request

info

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 Verification Status API retrieves the current status of a previously initiated Nafath verification request.

Use this API after initiating Nafath verification to determine whether the customer has completed the verification process before proceeding with SME account creation.

Domain details

Environment

Domain

Rate/Limit

Sandbox

sandboxapi.onesingleview.com

3 Calls per Minute

Production/LIVE

To be provided upon onboarding

Based on contract

Endpoint

Endpoint

Method

Authentication requirements

/api/v2/smeonboarding/nafathstatus

POST

Header

  • SVReferenceID
  • CompanyId
  • Device
  • DateTimeStamp
  • Access token

Request body

  • Signature

Sample request

Nafath Verification Status Request
curl --location 'https://sandboxapi.onesingleview.com/api/v2/smeonboarding/nafathstatus' \
--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": {
    "NafathStatusRequest": {
        "RequestId": "1650613225"
    }
},
"Signature": "rZZ9alg/2k9B5uWSdnW3AfYswAMqA4HXyNX3jIzckWb4o37uS4eKFEQ3xRn/dBarN6EGjfaXiMSOPdKyyjjrgT80K5ReXzQ7cC1INuU79ozlLgK8yTFz+nq785geQ+He4PR+hD35DkF9qnela9qmcr3GhAXpTjZG12hmaJEyzeofh6q3p+jqLFd208eAImubnL6SbSBDEAi5SLRH1K2I1U77OmFNirrfGV8qd+gsi+lqgyF9mpNj6lzy/fJNNe0qEr2WHvG1R7E2g3EhqovDNanQt6RFgkWegtlE37Eyi5qO3xlTqu76317ZWfMI7jHxs48fOLTNtBCOwUboVze5Tw=="
}'

Request parameters

JSON Tag

Requirement

Description

Data type

NafathStatusRequest

Mandatory

Root node containing information to request status of verification process

Object

RequestId

Mandatory

Value of BankReferenceNumber obtained in the response for initiate Nafath verification to be passed here to retrieve the current verification status

String

Sample response

Nafath Verification Status Response
{
    "NafathStatusResponse": {
        "StatusCode": "Completed",
        "StatusDetail": "Successful Operation",
        "Timestamp": "2026-08-27T07:26:59"
    },
    "Data": {
        "PlaceOfBirth": "",
        "Gender": "",
        "ThirdNameArabic": "",
        "IdIssueDate": "",
        "FirstNameArabic": "",
        "IdExpiryDate": "",
        "FirstNameEnglish": "",
        "ThirdNameEnglish": "",
        "SecondNameArabic": "",
        "Nationality": "",
        "RequestId": "18",
        "IdExpiryDateHijri": "",
        "IdIssuePlace": "",
        "LastNameEnglish": "",
        "Status": "WAITING",
        "SecondNameEnglish": ""
    }
}

Response parameters

JSON Tag

Description

Data type

NafathStatusResponse

Root node containing information of response for Nafath verification 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

Data

Tag carrying information on customer data and verification status

Object

PlaceOfBirth

Customer's place of birth (if available)

String

Gender

Customer's gender

String

ThirdNameArabic

Customer's third name in Arabic

String

IdIssueDate

ID issue date

String

FirstNameArabic

Customer's first name in Arabic

String

IdExpiryDate

ID expiry date

String

FirstNameEnglish

Customer's first name in English

String

ThirdNameEnglish

Customer's third name in English

String

SecondNameArabic

Customer's second name in Arabic

String

Nationality

Customer's nationality

String

RequestId

Identifier associated with the Nafath verification request

String

IdExpiryDateHijri

ID expiry date in Hijri format

String

IdIssuePlace

Place where the ID was issued

String

LastNameEnglish

Customer's last name in English

String

Status

Current status of the Nafath verification

String

SecondNameEnglish

Customer's second name in English

String

Status codes & information

StatusCode

StatusDetail

Completed

Successful Operation.

Failed

Bank response description

Response_Timeout

Timeout! Unable to get response from the bank. Please try again or contact SingleView support if issue persists.

Important information

A successful API response (StatusCode: Completed) means that the status request itself was processed successfully; it does not necessarily mean that the customer's Nafath verification is complete.

Use DStatus to determine the current verification state. In the example above, WAITING indicates that the Nafath verification is still in progress. Continue checking the status until the verification reaches the appropriate completion state before calling Create SME Account.

 

Updated September 1, 2026

PreviousInitiate Nafath verificationNextList of values
Was this helpful?