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:

Endpoint	`useCaseType` Value	`permissions` Value
`/v1/api/observice/connect`	`KYC`	`ReadParty` `ReadPartyPSU` `ReadPartyPSUIdentity` `ReadTransactionsBasic` `ReadTransactionsDetail` `ReadTransactionsCredits` `ReadTransactionsDebits`

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

Get KYC Services

Try in API Reference ➜

Endpoint details

Endpoint URL	Method	Authentication requirements
`/v1/api/observice/kyc`	POST	1. `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 Tag	Description	Data type
DateTimeStamp Mandatory	Stamp denoting the date and time of the request	String
RequestID Mandatory	Unique request identification	String
merchantId Mandatory	Unique merchant identification	String
fromDate Mandatory	Initial date of transaction period	String
toDate Mandatory	Final date of transaction period	String
kyc Mandatory	KYC service tag to be denoted as `true`	Boolean
banks Mandatory	Array of banks and consents	Object
code Mandatory	Unique bank identification code	String
consentId Mandatory	Unique consent identification	String

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 Tag	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
topDebits	Tag carrying information on top debits from the account
topCredits	Tag carrying information on top credits to the account