KYC

Verify KYC information of users and businesses

Introduction

KYC (Know Your Customer) API service streamlines and automates customer identification and verification by enabling businesses to integrate identity verification and KYC compliance checks into their systems or applications.

KYC API service lets you fetch real-time user or business information and KYC details by providing information on the associated parties.

Consent

User consent is the primary requirement to access any services in Open Banking. The user or account holder grants explicit consent to a Third-Party to access their financial data. This consent is given through a secure, multi-factor authentication process to verify the user's identity.

The consent request must include the following details:

EndpointuseCaseType Valuepermissions Value
/v1/api/observice/connectKYCReadParty
ReadPartyPSU
ReadPartyPSUIdentity
ReadTransactionsBasic
ReadTransactionsDetail
ReadTransactionsCredits
ReadTransactionsDebits

Check Consent Management for more details to create, view, and revoke consents.

Get KYC Services

Endpoint details

Endpoint URLMethodAuthentication requirements
/v1/api/observice/kycPOST1. clientId 2. clientCode 3. signature 4. Authorization Bearer: Token

Sample request

{
  "dateTimeStamp": "YYYY-MM-DDTHH:MM:SS",
  "requestID": "Enter_Request_Id",
  "merchantId": "Enter_Merchant_Id",
  "fromDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
  "toDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
  "kyc" : true,
  "banks": [
    {
      "code": "Enter_Bank_Code",
      "consentId":"Enter_Consent_Id"
    }
  ]
}

Request description

JSON TagDescriptionData type
DateTimeStamp
Mandatory
Stamp denoting the date and time of the requestString
RequestID
Mandatory
Unique request identificationString
merchantId
Mandatory
Unique merchant identificationString
fromDate
Mandatory
Initial date of transaction periodString
toDate
Mandatory
Final date of transaction periodString
kyc
Mandatory
KYC service tag to be denoted as trueBoolean
banks
Mandatory
Array of banks and consentsObject
code
Mandatory
Unique bank identification codeString
consentId
Mandatory
Unique consent identificationString

Sample response

{
  "success": true,
  "payload": [
    {
      "code": "Bank_Code",
      "data": {
        "party": [
          {
            "partyId": "Party_Id",
            "partyNumber": "Party_Number",
            "partyType": "Party_Type",
            "verifiedClaims": [
              {
                "verification": {
                  "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                  "verificationProcess": "Verification_Process_Mode",
                  "evidence": [
                    {
                      "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                      "type": "Type_of_Evidence",
                      "checkDetails": [
                        {
                          "txn": "Transaction_Details",
                          "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                          "checkMethod": "Checking_Method",
                          "organization": "Organization_Name"
                        },
                        {
                          "txn": "Transaction_Details",
                          "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                          "checkMethod": "Checking_Method",
                          "organization": "Organization_Name"
                        }
                      ],
                      "attachments": [
                        {
                          "desc": "Attachment_Description",
                          "contentType": "Type_of_Content",
                          "content": "Form_of_Content",
                          "txn": "Transaction_Details"
                        }
                      ],
                      "documentDetails": {
                        "type": "Type_of_Document",
                        "serialNumber": "Document_Serial_Number",
                        "personalNumber": "Document_Personal_Number",
                        "documentNumber": "Document_Number",
                        "dateOfIssuance": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                        "dateOfExpiry": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                        "calendarType": "Calendar_Type",
                        "issuer": {
                          "name": "Issuer_Bank_Name",
                          "countryCode": "Country_Code",
                          "jurisdiction": "Jurisdiction_Details",
                          "address": {
                            "formatted": "Formated",
                            "streetAddress": "Street_Address",
                            "locality": "Locality Info;",
                            "region": "Region_Details",
                            "postalCode": "Postal_Code",
                            "country": "Country"
                          }
                        }
                      },
                      "verifier": {
                        "organization": "Verifier_Organization",
                        "txn": "Transaction_Details"
                      }
                    },
                    {
                      "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                      "type": "Document_Type",
                      "checkDetails": [
                        {
                          "txn": "Transaction_Details",
                          "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                          "checkMethod": "Method_of_Checking",
                          "organization": "Organization_Name"
                        },
                        {
                          "txn": "Transaction_Details",
                          "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                          "checkMethod": "Method_of_Checking",
                          "organization": "Organization_Name"
                        }
                      ],
                      "attachments": [
                        {
                          "desc": "Attachment_Description",
                          "contentType": "Type_of_Content",
                          "content": "Form_of_Content",
                          "txn": "Transaction_Details"
                        }
                      ],
                      "documentDetails": {
                        "type": "Type_of_Document",
                        "serialNumber": "Document_Serial_Number",
                        "personalNumber": "Document_Personal_Number",
                        "documentNumber": "Document_Number",
                        "dateOfIssuance": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                        "dateOfExpiry": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                        "calendarType": "Calendar_Type",
                        "issuer": {
                          "name": "Issuer_Bank_Name",
                          "countryCode": "Country_Code",
                          "jurisdiction": "Jurisdiction_Details",
                          "address": {
                            "formatted": "Formated",
                            "streetAddress": "Street_Address",
                            "locality": "Locality Info;",
                            "region": "Region_Details",
                            "postalCode": "Postal_Code",
                            "country": "Country"
                          }
                        }
                      },
                      "verifier": {
                        "organization": "Verifier_Organization",
                        "txn": "Transaction_Details"
                      }
                    },
                    {
                      "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                      "type": "Document_Type",
                      "checkDetails": [
                        {
                          "txn": "Transaction_Details",
                          "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                          "checkMethod": "Method_of_Checking",
                          "organization": "Organization_Name"
                        },
                        {
                          "txn": "Transaction_Details",
                          "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
                          "checkMethod": "Method_of_Checking",
                          "organization": "Organization_Name"
                        }
                        }
                      ],
                      "trustFramework": "Trust_Framework_Details",
                      "assuranceLevel": "Level_of_Assurance",
                      "assuranceProcess": {
                        "policy": "Assurance_Policy",
                        "procedure": "Assurance_Procedure",
                        "assuranceDetails": [
                          {
                            "assuranceType": "Type_of_Assurance",
                            "assuranceClassification": "Classification_of_Assurance",
                            "evidenceRef": [
                              {
                                "txn": "Transaction_Details",
                                "evidenceMetadata": {
                                  "evidenceClassification": "Evidence_Classification"
                                }
                              }
                            ]
                          },
                          {
                            "assuranceType": "Type_of_Assurance",
                            "assuranceClassification": "Classification_of_Assurance",
                            "evidenceRef": [
                              {
                                "txn": "Transaction_Details",
                                "evidenceMetadata": {
                                  "evidenceClassification": "Evidence_Classification"
                                }
                              },
                              {
                                "txn": "Transaction_Details",
                                "evidenceMetadata": {
                                  "evidenceClassification": "Evidence_Classification"
                                }
                              }
                            ]
                          }
                        ]
                      }
                    },
                    "claims":{
                    "sub": "Subject",
                    "name": "Name",
                    "givenName": "Given_Name",
                    "familyName": "Family_Name",
                    "middleName": "Middle_Name",
                    "nickname": "Nickname",
                    "preferredUsername": "Preferred_Username",
                    "profile": "Profile_Details",
                    "picture": "Picture_Details",
                    "website": "Website_Info",
                    "email": "Email_Address",
                    "emailVerified": true/false,
                    "gender": "Gender",
                    "birthDate": "YYYY-MM-DD",
                    "phoneNumber": "Phone_Number",
                    "phoneNumberVerified": true/false,
                    "title": "Title",
                    "msisdn": "Mobile_Station_International_Subscriber_Directory_Number",
                    "zoneInfo": "Zone_Info",
                    "locale": "Locale_Info",
                    "salutation": "Salutation",
                    "birthFamilyName": "Birth_Family_Name",
                    "birthGivenName": "Birth_Given_Name",
                    "birthMiddleName": "Birth_Middle_Name",
                    "alsoKnownAs": "AKA_Details",
                    "placeOfBirth": {
                    "country": "Country_Code",
                    "region": "Region",
                    "locality": "Locality"
                    },
                "nationalities": [
                  "Country_Code"
                ],
                "address": {
                  "formatted": "Format_Status",
                  "streetAddress": "Street_Address",
                  "locality": "Locality",
                  "region": "Region",
                  "postalCode": "Postal_Code",
                  "country": "Country_Code"
                }
              }
              },
              {
              "verification": {
              "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
              "verificationProcess": "Verification_Process_Mode",
              "evidence": [
              {
              "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
              "type": "Type_of_Evidence",
              "checkDetails": [
              {
              "txn": "Transaction_Details",
              "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
              "checkMethod": "Checking_Method",
              "organization": "Organization_Name"
              },
          {
            "txn": "Transaction_Details",
            "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "checkMethod": "Checking_Method",
            "organization": "Organization_Name"
          }
        ],
        "attachments": [
          {
            "desc": "Attachment_Description",
            "contentType": "Type_of_Content",
            "content": "Form_of_Content",
            "txn": "Transaction_Details"
          }
        ],
        "documentDetails": {
          "type": "Type_of_Document",
          "serialNumber": "Document_Serial_Number",
          "personalNumber": "Document_Personal_Number",
          "documentNumber": "Document_Number",
          "dateOfIssuance": "YYYY-MM-DDTHH:MM:SS.SSSZ",
          "dateOfExpiry": "YYYY-MM-DDTHH:MM:SS.SSSZ",
          "calendarType": "Calendar_Type",
          "issuer": {
            "name": "Issuer_Bank_Name",
            "countryCode": "Country_Code",
            "jurisdiction": "Jurisdiction_Details",
            "address": {
              "formatted": "Formated",
              "streetAddress": "Street_Address",
              "locality": "Locality Info;",
              "region": "Region_Details",
              "postalCode": "Postal_Code",
              "country": "Country"
            }
          }
        },
        "verifier": {
          "organization": "Verifier_Organization",
          "txn": "Transaction_Details"
        }
      },
      {
      "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
      "type": "Document_Type",
      "checkDetails": [
      {
      "txn": "Transaction_Details",
      "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
      "checkMethod": "Method_of_Checking",
      "organization": "Organization_Name"
    },
    {
      "txn": "Transaction_Details",
      "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
      "checkMethod": "Method_of_Checking",
      "organization": "Organization_Name"
    }
  ],
  "attachments": [
    {
      "desc": "Attachment_Description",
      "contentType": "Type_of_Content",
      "content": "Form_of_Content",
      "txn": "Transaction_Details"
    }
  ],
  "documentDetails": {
    "type": "Type_of_Document",
    "serialNumber": "Document_Serial_Number",
    "personalNumber": "Document_Personal_Number",
    "documentNumber": "Document_Number",
    "dateOfIssuance": "YYYY-MM-DDTHH:MM:SS.SSSZ",
    "dateOfExpiry": "YYYY-MM-DDTHH:MM:SS.SSSZ",
    "calendarType": "Calendar_Type",
    "issuer": {
      "name": "Issuer_Bank_Name",
      "countryCode": "Country_Code",
      "jurisdiction": "Jurisdiction_Details",
      "address": {
        "formatted": "Formated",
        "streetAddress": "Street_Address",
        "locality": "Locality Info;",
        "region": "Region_Details",
        "postalCode": "Postal_Code",
        "country": "Country"
      }
    }
  },
  "verifier": {
    "organization": "Verifier_Organization",
    "txn": "Transaction_Details"
  }
},
{
  "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
  "type": "Document_Type",
  "checkDetails": [
    {
      "txn": "Transaction_Details",
      "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
      "checkMethod": "Method_of_Checking",
      "organization": "Organization_Name"
    },
    {
      "txn": "Transaction_Details",
      "time": "YYYY-MM-DDTHH:MM:SS.SSSZ",
      "checkMethod": "Method_of_Checking",
      "organization": "Organization_Name"
    }
    }
  ],
  "trustFramework": "Trust_Framework_Details",
  "assuranceLevel": "Level_of_Assurance",
  "assuranceProcess": {
    "policy": "Assurance_Policy",
    "procedure": "Assurance_Procedure",
    "assuranceDetails": [
      {
        "assuranceType": "Type_of_Assurance",
        "assuranceClassification": "Classification_of_Assurance",
        "evidenceRef": [
          {
            "txn": "Transaction_Details",
            "evidenceMetadata": {
              "evidenceClassification": "Evidence_Classification"
            }
          }
        ]
      },
      {
        "assuranceType": "Type_of_Assurance",
        "assuranceClassification": "Classification_of_Assurance",
        "evidenceRef": [
          {
            "txn": "Transaction_Details",
            "evidenceMetadata": {
              "evidenceClassification": "Evidence_Classification"
            }
          },
          {
            "txn": "Transaction_Details",
            "evidenceMetadata": {
              "evidenceClassification": "Evidence_Classification"
            }
          }
        ]
      }
    ]
  }
},
"claims":{
  "sub": "Subject",
  "name": "Name",
  "givenName": "Given_Name",
  "familyName": "Family_Name",
  "middleName": "Middle_Name",
  "nickname": "Nickname",
  "preferredUsername": "Preferred_Username",
  "profile": "Profile_Details",
  "picture": "Picture_Details",
  "website": "Website_Info",
  "email": "Email_Address",
  "emailVerified": true/false,
  "gender": "Gender",
  "birthDate": "YYYY-MM-DD",
  "phoneNumber": "Phone_Number",
  "phoneNumberVerified": true/false,
  "title": "Title",
  "msisdn": "Mobile_Station_International_Subscriber_Directory_Number",
  "zoneInfo": "Zone_Info",
  "locale": "Locale_Info",
  "salutation": "Salutation",
  "birthFamilyName": "Birth_Family_Name",
  "birthGivenName": "Birth_Given_Name",
  "birthMiddleName": "Birth_Middle_Name",
  "alsoKnownAs": "AKA_Details",
  "placeOfBirth": {
    "country": "Country_Code",
    "region": "Region",
    "locality": "Locality"
  },
  "nationalities": [
    "Country_Code"
  ],
  "address": {
    "formatted": "Format_Status",
    "streetAddress": "Street_Address",
    "locality": "Locality",
    "region": "Region",
    "postalCode": "Postal_Code",
    "country": "Country_Code"
  }
}
}
],
"accountRole": "Account_Role_Details"
}
]
},
"links": {
  "self": "https://"
},
"meta": {
  "totalPages": 0
}
}
],
"topDebits": [],
"topCredits": []
}

Response description

JSON TagDescription
successProcess success status represented as true or false
payloadTag carrying the response information
codeUnique bank identification code
dataTag carrying the response data of the accounts
partyTag carrying party information
partyIdUnique identification of a party
partyNumberParty Number
partyTypeType of party for the specific account
verifiedClaimsTag carrying information on verifications and claims
verificationTag carrying verification information
timeTime of verification
verificationProcessMode of verification process carried out either online or offline
evidenceTag carrying information about the evidences involved/used for verification
timeTime of evidence
typeType of evidence
checkDetailsDetails check information tag
txnTransaction identification details
timeTime of transaction
checkMethodMethod of checking either online or offline
organizationName of the checking organization
attachmentsTag carrying attachment information
descDescription of the attachment
contentTypeType of content included in the attachment
contentForm of content in the attachment
txnTransaction identification details
documentDetailsTag carrying document details
typeType of document
serialNumberSerial number of the document
personalNumberPersonal number specified in the document
documentNumberDocument number
dateOfIssuanceDate of issuance of the document
dateOfExpiryDate of expiry of the document
calendarTypeCalendar type followed by the document
issuerTag carrying information about the issuer of the document
nameName of the issuer of the document
countryCodeCode of country issuing the document
jurisdictionJurisdiction of the document
addressTag carrying address information of the issuer
formattedInformation status as formatted or unformatted
streetAddressStreet address of the issuer
localityLocality of the issuer
regionRegion of the issuer
postalCodePostal code of the issuer
countryCountry of the issuer
verifierTag carrying information about the verifier
organizationVerifying organization name
txnTransaction identification details
trustFrameworkDetails about the trust framework
assuranceLevelAssurance level specification
assuranceProcessTag carrying assurance process details
policyAssurance policy details
procedureAssurance policy procedure
assuranceDetailsTag carrying assurance details
assuranceTypeType of assurance
assuranceClassificationClassification of assurance
evidenceRefTag carrying evidence reference information
txnTransaction identification details
evidenceMetadataTag carrying evidence meta data
evidenceClassificationClassification details of the evidence
claimsTag carrying claims information
subSubject of the claim
nameName of the claim
givenNameGiven name for the claim
familyNameFamily name of the claiming party
middleNameMiddle name of the claiming party
nicknameNickname of the claiming party
preferredUsernamePreferred username of the claiming party
profileProfile details of the claiming party
picturePicture of the claiming party
websiteWebsite of the claiming party
emailemail address of the claiming party
emailVerifiedEmail verification status
genderGender of the claiming party
birthDateDate of birth of the claiming party
phoneNumberPhone number of the claiming party
phoneNumberVerifiedPhone number verification status
titleTitle information
msisdnMobile Station International Subscriber Directory Number
zoneInfoZone information
localeLocale details
salutationSalutation of the claiming party
birthFamilyNameBirth family name of the claiming party
birthGivenNameBirth given name of the claiming party
birthMiddleNameBirth middle name of the claiming party
alsoKnownAsAKA name of the claiming party
placeOfBirthTag carrying place of birth information of the claiming party
countryCountry of birth
regionRegion of birth
localityLocality of birth
nationalitiesArray of strings carrying the information on the nationalities of the claiming party
addressAddress tag of the claiming party
formattedFormat status either formatted or unformatted
streetAddressStreet address of the claiming party
localityLocality details of the claiming party
regionRegion of the claiming party
postalCodePostal code of the claiming party
countryCountry code of the claiming party
accountRoleDetails on account role
linksTag carrying links
selfLink/URL to self platform
metaMeta tag of the response
totalPagesRepresentation of response in terms if page length
topDebitsTag carrying information on top debits from the account
topCreditsTag carrying information on top credits to the account