---
title: PULL KYC
description: KYC- Know Your Customer. It is a process by which we can obtain information about the identity and address. The customer can add KYC related documents and details through this API.
---

# KYC - Pull KYC

The API below will be used to fetch the KYC details of the customer to view for verification.

Note: max 50 UIDs can be shared in single api call. If record already exist, existing record will be overridden and updated. Only new records will be added and existing will be updated.

## POST

```
Merchant-defined-url
```

## Header

| Field | Type | Description |
| --- | --- | --- |
| Content-Type | String | application/json |

## Parameter

| Field | Type | Description |
| --- | --- | --- |
| merchant_id | Number | Merchant ID (length 1-20) (required) |
| private_key | String | Private Key (length 10-200) (required)<br>private_key = hash('sha256', secret.'@'.username.':|:'.password) |
| checksum | String | Checksum (length 10-200) (required)<br>date = YYYY-MM-DD<br>alldata = merchant_id.private_key.UIDDATA<br>Key generated by : key = hash('SHA256',username."~:~".password)<br>checksum generated by : checksum = hash('SHA256', key.'@'.alldata) |
| UID | String | Customer UID shared by merchant (required) |
| UIDDATA | Json | Group of UIDs (required)<br>[ "UID1", "UID2", "UID3", ., ., "UID50" ] |
## Request-Example:

```
        {
			 	"merchant_id" : "11111",
				"private_key" : "71a4efaf21c79864ec154babfc494f45fd1f65a570805084965d5b29486f1dfe",
				"checksum" : "92c617a556982a8d124ff2b7ce9eae3e",
				"UIDDATA" : [
                     "UID1",
                     "UID2",
                     "UID3",
                     .,
                     .,
                     "UID50"
                     ]
			}
```

## Success 200

| Field | Type | Description |
| --- | --- | --- |
| status | Number | 200 or 400 |
| message | String | Status Message for<br>200 : Success, 400 : Failed |
| kyc_data | Json | KYC Data<br>[ { "UID": "ehrjdsihogfoejroejfrjwfw9f9ewu49r4m4t9rrtj04", "kycinfo": [ { "kyc_type": "PC", "kyc_number": "321400006787" }, { "kyc_type": "PP", "kyc_number": "321400006787" } ] }, { "UID": "UID", "kycinfo": [ { "kyc_type": "DL", "kyc_number": "2938934hhh3" } ] } ]<br>kyc_type | String | KYC type (length 2-5) Customer Name - CNCustomer Email - EMPhone Number - PNDriving Licence - DLPancard - PCPassport - PP<br>kyc_number | String | KYC number (length 8-100), SHA256 encryption<br>SHA256 logic: kychashkey = hash('SHA256',username."~:~".password);kyc_number = hash('SHA256', kychashkey.'@'.kyc_number); |

## For Success:

```
    HTTP/1.1 200 OK
     {
	        "status" : "200",
	        "message" : "Success",
	        "kyc_data" : "[
	          {
	            "UID": "ehrjdsihogfoejroejfrjwfw9f9ewu49r4m4t9rrtj04",
	            "kycinfo": [
	              {
	                "kyc_type": "PP",
	                "kyc_number": "321400006787"
	              },
	              {
	                "kyc_type": "PC",
	                "kyc_number": "321400006787"
	              }
	            ]
	          },
	          {
	            "UID": "UID",
	            "kycinfo": [
	              {
	                "kyc_type": "DL",
	                "kyc_number": "2938934hhh3"
	              }
	            ]
	          }
	        ]"
     }
```
## For Failure:
```
    HTTP/1.1 200 OK
     {
	        "status" : "400",
	        "message" : "Failed",
     }
```