Get Vendor All Documents Status
curl --request GET \
--url https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id} \
--header 'x-api-version: <x-api-version>' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'import requests
url = "https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id}"
headers = {
"x-api-version": "<x-api-version>",
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'x-api-version': '<x-api-version>',
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>'
}
};
fetch('https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-version: <x-api-version>",
"x-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-version", "<x-api-version>")
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id}")
.header("x-api-version", "<x-api-version>")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"related_docs": [
{
"vendor_id": "johntest11111",
"doc_type": "CIN_NUMBER",
"doc_value": "L00000Aa0000AaA000000",
"status": "IN_REVIEW",
"remarks": null
},
{
"vendor_id": "johntest11111",
"doc_type": "GSTIN_NUMBER",
"doc_value": "11AAAAA1111A1Z0",
"status": "IN_REVIEW",
"remarks": null
},
{
"vendor_id": "johntest11111",
"doc_type": "PAN_NUMBER",
"doc_value": "BIAPA2934N",
"status": "IN_REVIEW",
"remarks": null
},
{
"vendor_id": "johntest11111",
"doc_type": "PASSPORT_NUMBER",
"doc_value": "L6892603",
"status": "IN_REVIEW",
"remarks": null
},
{
"vendor_id": "johntest11111",
"doc_type": "UIDAI_NUMBER",
"doc_value": 753624181019,
"status": "IN_REVIEW",
"remarks": null
}
]
}
Vendors
Get Vendor All Documents Status
Use this API to fetch the details of all the KYC details of a particular vendor.
GET
/
easy-split
/
vendor-docs
/
{vendor_id}
Get Vendor All Documents Status
curl --request GET \
--url https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id} \
--header 'x-api-version: <x-api-version>' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'import requests
url = "https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id}"
headers = {
"x-api-version": "<x-api-version>",
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'x-api-version': '<x-api-version>',
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>'
}
};
fetch('https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-version: <x-api-version>",
"x-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-version", "<x-api-version>")
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id}")
.header("x-api-version", "<x-api-version>")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/pg/easy-split/vendor-docs/{vendor_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"related_docs": [
{
"vendor_id": "johntest11111",
"doc_type": "CIN_NUMBER",
"doc_value": "L00000Aa0000AaA000000",
"status": "IN_REVIEW",
"remarks": null
},
{
"vendor_id": "johntest11111",
"doc_type": "GSTIN_NUMBER",
"doc_value": "11AAAAA1111A1Z0",
"status": "IN_REVIEW",
"remarks": null
},
{
"vendor_id": "johntest11111",
"doc_type": "PAN_NUMBER",
"doc_value": "BIAPA2934N",
"status": "IN_REVIEW",
"remarks": null
},
{
"vendor_id": "johntest11111",
"doc_type": "PASSPORT_NUMBER",
"doc_value": "L6892603",
"status": "IN_REVIEW",
"remarks": null
},
{
"vendor_id": "johntest11111",
"doc_type": "UIDAI_NUMBER",
"doc_value": 753624181019,
"status": "IN_REVIEW",
"remarks": null
}
]
}
Authorizations
XClientID & XClientSecretXClientID & XPartnerAPIKeyXClientID & XClientSignatureHeaderXPartnerMerchantID & XPartnerAPIKey
Client app ID. You can find your app id in the Merchant Dashboard.
Client secret key. You can find your secret key in the Merchant Dashboard.
Headers
API version to be used
Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.
Path Parameters
The id which uniquely identifies your vendor.
Response
Get Vendor Docs Success Response.
Get Vendor Documents
Show child attributes
Show child attributes
Was this page helpful?
āI