Create a user profile for the SME owner and configure the access credentials
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.
Manage user API creates the SME owner's user profile after successful customer validation. It captures the customer's contact details and onboarding credentials, including the Pass Code and Security PIN.
The API also returns an OTP that can be used in the subsequent onboarding 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/manageuser' \
--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": {
"ManageUserRequest": {
"DOB": "09/09/1409",
"EmailAddress": "alsamoli@organization.com.sa",
"IdNumber": "1980651234",
"UnifiedNumber": "7007521015",
"SecurityPin": "1234",
"MobileNumber": "966599620904",
"PassCode": "72123",
"FunctionId": "IVR001"
}
},
"Signature": "rZZ9alg/2k9B5uWSdnW3AfYswAMqA4HXyNX3jIzckWb4o37uS4eKFEQ3xRn/dBarN6EGjfaXiMSOPdKyyjjrgT80K5ReXzQ7cC1INuU79ozlLgK8yTFz+nq785geQ+He4PR+hD35DkF9qnela9qmcr3GhAXpTjZG12hmaJEyzeofh6q3p+jqLFd208eAImubnL6SbSBDEAi5SLRH1K2I1U77OmFNirrfGV8qd+gsi+lqgyF9mpNj6lzy/fJNNe0qEr2WHvG1R7E2g3EhqovDNanQt6RFgkWegtlE37Eyi5qO3xlTqu76317ZWfMI7jHxs48fOLTNtBCOwUboVze5Tw=="
}'Request parameters
JSON Tag | Requirement | Description | Data type |
|---|---|---|---|
ManageUserRequest | Mandatory | Root node containing information to request to manage customer information | Object |
DOB | Mandatory | Date of birth of the SME owner, according to the applicable calendar type as passed in the Validate Customer request | String |
EmailAddress | Mandatory | Email address associated with the SME owner | String |
IdNumber | Mandatory | Customer's Iqama/ID number | String |
UnifiedNumber | Mandatory | SME's Commercial Registration (CR) Unified Number | String |
SecurityPin | Mandatory | Security PIN defined by the user during onboarding and used for account recovery | String |
MobileNumber | Mandatory | Customer's registered mobile number, including the country code | String |
PassCode | Mandatory | Pass Code defined by the user during onboarding and used to log in to Bank Albilad channels | String |
FunctionId | Mandatory | Identifier for the function or service being requested | String |
{
"ManageUserResponse": {
"StatusCode": "Completed",
"StatusDetail": "User Created Successfully",
"ReferenceNumber": "23341800",
"OTP": "9932",
"Expiry": "7"
}
}Response parameters
JSON Tag | Description | Data type |
|---|---|---|
ManageUserResponse | Root node containing information of response for managing customer information | 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 |
OTP | OTP generated as part of the user creation process | String |
Expiry | OTP validity period, in minutes. The example returns | String |
StatusCode | StatusDetail |
|---|---|
Completed | User Created Successfully. |
Failed | Bank response description |
Response_Timeout | Timeout! Unable to get response from the bank. Please try again or contact SingleView support if issue persists. |