Verify customer identity

Customer Verification service enables you to validate a customer's identity using trusted information maintained by the financial institution. The service returns verified identity attributes, contact details, address information, and verification evidence that can be used to support onboarding, compliance, fraud prevention, and Know Your Customer (KYC) processes.

Customer Verification service provides access to verified customer identity information associated with an authorized consent.

Using this service, you can:

Verify customer identity information.
Validate customer contact details.
Retrieve verified identity claims.
Support onboarding and KYC workflows.
Reduce fraud and identity-related risks.
Improve customer verification processes.

The response includes both customer identity attributes and the verification evidence used by the financial institution.

Important information

The consentId must refer to an active and authorized consent
A valid access token must be included in the Authorization: Bearer header

This API can only be accessed using a valid and active consent. Before accessing this service, ensure that a consent has been created and authorized with the required useCaseType and permissions.

The consent must include the appropriate useCaseType and permission values that allow access to the corresponding financial data services.

If you do not already have a consent with the required configuration, you must first create one using the Create Consent API and ensure that it is successfully authorized. Once the consent becomes active, the generated consentId can be used to access this API service.

Scope	useCaseType	Permissions
To access Customer Verification service under Data Use Case APIs	`CUSTOMERVERIFICATION`	`"ReadParty",` `"ReadPartyPSU",` `"ReadPartyPSUIdentity",`

Scope

useCaseType

Permissions

To access Customer Verification service under Data Use Case APIs

CUSTOMERVERIFICATION

"ReadParty",

"ReadPartyPSU",

"ReadPartyPSUIdentity",

This service requires consentId and returns all accounts parties associated with that consent for verification.

Endpoint

Endpoint URL	Method
`/v2/api/observice/customerVerify`	GET

Header

The following headers must be included when calling the Customer Verification API.

Header parameter	Description
`Authorization: Bearer`	Access token used to authenticate the API request

Sample request

Example to initiate request to retrieve customer information from accounts

curl --request GET \
     --url 'https://obsandbox.onesingleview.com/v2/api/observice/customerVerify?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&bankCode=SVMOB1&consentId=urn%3ASVMOB%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1&customerVerification=true' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNYVR4WGpBZU5qU1FWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUZ1TTJ6NmIzbi9WVE1aK1FucERJMEZXWWN6VGJsOEc5cXhaY0VLUTZZWEFsYmZnejdkdlFpTTRXeVBNalQ2WG1NUDh5YXI4RDVWZTUwUGhYbDcwYkYxRENJeEpDaU5TVkhBKytXYnRUZkhDblVBPT0iLCJpYXQiOjE3ODE1OTAwMDksImV4cCI6MTc4MTU5MzYwOX0.MO69uVzXyHqN2UBxvxCn3sBZcOpNWYP7bsQPe-qdGsQ'

Request parameters

Parameters	Requirement	Description	Data type	Data validation
dateTimeStamp	Mandatory	Indicates the date and time when the request is created	Date	ISO 8601 format YYYY-MM-DDTHH:MM:SS
requestID	Mandatory	Unique identifier for the request used for tracking and traceability	Alphanumeric	UUID format
merchantID	Mandatory	Identifier assigned to the merchant or client application initiating the request	String
customerVerify	Mandatory	Specification of data use case API	Enum	`true` or `false`
bankCode	Mandatory	Unique bank identifier code	Enum
consentId	Mandatory	Unique identifier of the consent	String

Sample response

Example response for a successfully retrieved information of all account owners

{
  "success": true,
  "payload": [
    {
      "code": "SVMOB1",
      "data": {
        "party": [
          {
            "partyId": "100001000000000000000002",
            "partyNumber": "202",
            "partyType": "KSAOB.Sole",
            "verifiedClaims": [
              {
                "verification": {
                  "time": "2017-04-05T10:43:07+00:00",
                  "verificationProcess": "online",
                  "evidence": [
                    {
                      "time": "2021-05-21T08:30:00Z",
                      "type": "document",
                      "checkDetails": [
                        {
                          "txn": "Txn1234",
                          "time": "2021-05-21T08:30:00Z",
                          "checkMethod": "Online",
                          "organization": "Ozone"
                        }
                      ],
                      "attachments": [
                        {
                          "desc": "banking doc",
                          "contentType": "text",
                          "content": "data",
                          "txn": "TXN-12344"
                        }
                      ],
                      "documentDetails": {
                        "type": "passport",
                        "serialNumber": "12345657",
                        "personalNumber": "12345657",
                        "documentNumber": "678543221",
                        "dateOfIssuance": "2019-09-21T08:30:00Z",
                        "dateOfExpiry": "2021-05-21T08:30:00Z",
                        "calendarType": "KSAOB.IslamicCalendar",
                        "issuer": {
                          "name": "bank test",
                          "countryCode": "US",
                          "jurisdiction": "justTest",
                          "address": {
                            "formatted": "Formated",
                            "streetAddress": "369-A",
                            "locality": "Waked",
                            "region": "So",
                            "postalCode": "38701",
                            "country": "US"
                          }
                        }
                      },
                      "verifier": {
                        "organization": "ozone",
                        "txn": "TXN-12345"
                      }
                    }
                  ],
                  "trustFramework": "SA_IAM",
                  "assuranceLevel": "First level",
                  "assuranceProcess": {
                    "policy": "XYZ",
                    "procedure": "Data proces",
                    "assuranceDetails": [
                      {
                        "assuranceType": "assurance_process1",
                        "assuranceClassification": "classifications",
                        "evidenceRef": [
                          {
                            "txn": "Txn-1234",
                            "evidenceMetadata": {
                              "evidenceClassification": "test"
                            }
                          }
                        ]
                      }
                    ]
                  }
                },
                "claims": {
                  "sub": "5dd713d9-2b05-4f1e-868f-f53962c28c2b",
                  "name": "Abdullah Otaibi",
                  "givenName": "Abdullah Otaibi",
                  "familyName": "Abdullah",
                  "middleName": "Mohammad",
                  "nickname": "Otaibi",
                  "preferredUsername": "Otaibi",
                  "profile": "Abdullah Otaibi",
                  "email": "abdullahotaibi@email.com",
                  "emailVerified": true,
                  "gender": "Male",
                  "birthDate": "1970-01-01",
                  "phoneNumber": "+966591112222",
                  "phoneNumberVerified": true,
                  "title": "Mr",
                  "msisdn": "011 222 3333",
                  "zoneInfo": "Ras Al Khair - Northeast",
                  "locale": "ar-SA",
                  "salutation": "Mr",
                  "birthFamilyName": "Otaibi",
                  "birthGivenName": "Abdullah Otaibi",
                  "birthMiddleName": "Mohammad",
                  "alsoKnownAs": "Abdullah Otaibi",
                  "placeOfBirth": {
                    "country": "SA",
                    "region": "Riyadh",
                    "locality": "ar-SA"
                  },
                  "nationalities": [
                    "Arabs"
                  ],
                  "address": {
                    "formatted": "1929",
                    "streetAddress": "Rayhanah Bint Zaid",
                    "locality": "Olaya",
                    "region": "Riyadh",
                    "postalCode": "12345",
                    "country": "SA"
                  }
                }
              }
            ],
            "accountRole": "KSAOB.SecondaryOwner"
          }
        ]
      },
      "links": {
        "self": ""
      },
      "meta": {
        "totalPages": 1
      }
    }
  ]
}

Response parameters

Parameter	Description
success	Process success status represented as `true` or `false`
payload	Tag carrying the response information
code	Unique bank identification code
data	Tag carrying the response data of the accounts
party	Tag carrying party information
partyId	Unique identification of a party
partyNumber	Party Number
partyType	Type of party for the specific account
verifiedClaims	Tag carrying information on verifications and claims
verification	Tag carrying verification information
time	Time of verification
verificationProcess	Mode of verification process carried out either `online` or `offline`
evidence	Tag carrying information about the evidences involved/used for verification
time	Time of evidence
type	Type of evidence
checkDetails	Details check information tag
txn	Transaction identification details
time	Time of transaction
checkMethod	Method of checking either `online` or `offline`
organization	Name of the checking organization
attachments	Tag carrying attachment information
desc	Description of the attachment
contentType	Type of content included in the attachment
content	Form of content in the attachment
txn	Transaction identification details
documentDetails	Tag carrying document details
type	Type of document
serialNumber	Serial number of the document
personalNumber	Personal number specified in the document
documentNumber	Document number
dateOfIssuance	Date of issuance of the document
dateOfExpiry	Date of expiry of the document
calendarType	Calendar type followed by the document
issuer	Tag carrying information about the issuer of the document
name	Name of the issuer of the document
countryCode	Code of country issuing the document
jurisdiction	Jurisdiction of the document
address	Tag carrying address information of the issuer
formatted	Information status as `formatted` or `unformatted`
streetAddress	Street address of the issuer
locality	Locality of the issuer
region	Region of the issuer
postalCode	Postal code of the issuer
country	Country of the issuer
verifier	Tag carrying information about the verifier
organization	Verifying organization name
txn	Transaction identification details
trustFramework	Details about the trust framework
assuranceLevel	Assurance level specification
assuranceProcess	Tag carrying assurance process details
policy	Assurance policy details
procedure	Assurance policy procedure
assuranceDetails	Tag carrying assurance details
assuranceType	Type of assurance
assuranceClassification	Classification of assurance
evidenceRef	Tag carrying evidence reference information
txn	Transaction identification details
evidenceMetadata	Tag carrying evidence meta data
evidenceClassification	Classification details of the evidence
claims	Tag carrying claims information
sub	Subject of the claim
name	Name of the claim
givenName	Given name for the claim
familyName	Family name of the claiming party
middleName	Middle name of the claiming party
nickname	Nickname of the claiming party
preferredUsername	Preferred username of the claiming party
profile	Profile details of the claiming party
picture	Picture of the claiming party
website	Website of the claiming party
email	email address of the claiming party
emailVerified	Email verification status
gender	Gender of the claiming party
birthDate	Date of birth of the claiming party
phoneNumber	Phone number of the claiming party
phoneNumberVerified	Phone number verification status
title	Title information
msisdn	Mobile Station International Subscriber Directory Number
zoneInfo	Zone information
locale	Locale details
salutation	Salutation of the claiming party
birthFamilyName	Birth family name of the claiming party
birthGivenName	Birth given name of the claiming party
birthMiddleName	Birth middle name of the claiming party
alsoKnownAs	AKA name of the claiming party
placeOfBirth	Tag carrying place of birth information of the claiming party
country	Country of birth
region	Region of birth
locality	Locality of birth
nationalities	Array of strings carrying the information on the nationalities of the claiming party
address	Address tag of the claiming party
formatted	Format status either `formatted` or `unformatted`
streetAddress	Street address of the claiming party
locality	Locality details of the claiming party
region	Region of the claiming party
postalCode	Postal code of the claiming party
country	Country code of the claiming party
accountRole	Details on account role
links	Tag carrying links
self	Link/URL to self platform
meta	Meta tag of the response
totalPages	Representation of response in terms if page length

Categories

GENERAL INFORMATION

GETTING STARTED

CONSENT MANAGEMENT

Raw Data APIs

DATA USE CASE APIS

Plug-and-Play Integrations

RESOURCES

API Archives

Verify customer identity