Get Entity Details
curl --request GET \
--url https://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity \
--header 'Authorization: <authorization>' \
--header 'x-api-key: <x-api-key>'import requests
url = "https://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity"
headers = {
"Authorization": "<authorization>",
"x-api-key": "<x-api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: '<authorization>', 'x-api-key': '<x-api-key>'}
};
fetch('https://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity', 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://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"x-api-key: <x-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://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("x-api-key", "<x-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://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity")
.header("Authorization", "<authorization>")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"code": 200,
"timestamp": 1765888767565,
"data": {
"id": "4e8455e8-27db-50a0-99e9-0b0211a4811d",
"@entity": "in.co.sandbox.kyc.entitylocker.entity",
"date_of_incorporation": "16/01/2023",
"email": "help@sandbox.co.in",
"mobile": "9099983246",
"name": "SANDBOX FINANCIAL TECHNOLOGIES PRIVATE LIMITED",
"verified_by": "cin"
},
"transaction_id": "c4124d99-4854-446f-9b04-b8f8c12785d0"
}Get Entity Details
Get Entity Details API returns the entity details used to access EntityLocker documents
GET
/
kyc
/
entitylocker
/
sessions
/
{session_id}
/
entity
Get Entity Details
curl --request GET \
--url https://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity \
--header 'Authorization: <authorization>' \
--header 'x-api-key: <x-api-key>'import requests
url = "https://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity"
headers = {
"Authorization": "<authorization>",
"x-api-key": "<x-api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: '<authorization>', 'x-api-key': '<x-api-key>'}
};
fetch('https://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity', 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://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"x-api-key: <x-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://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("x-api-key", "<x-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://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity")
.header("Authorization", "<authorization>")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/entity")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"code": 200,
"timestamp": 1765888767565,
"data": {
"id": "4e8455e8-27db-50a0-99e9-0b0211a4811d",
"@entity": "in.co.sandbox.kyc.entitylocker.entity",
"date_of_incorporation": "16/01/2023",
"email": "help@sandbox.co.in",
"mobile": "9099983246",
"name": "SANDBOX FINANCIAL TECHNOLOGIES PRIVATE LIMITED",
"verified_by": "cin"
},
"transaction_id": "c4124d99-4854-446f-9b04-b8f8c12785d0"
}Run in Postman
Headers
JWT access token. For token-generation steps, refer to the Quickstart Guide.
API key used to identify and authenticate the client.
Specifies the API version for the request.
Path Parameters
Session identifier generated during EntityLocker Initiate Session API .
Response
200 - application/json
HTTP status code.
Unix timestamp (in milliseconds) indicating when the server generated the response.
Response payload containing the requested data or error details.
Show child attributes
Show child attributes
Unique identifier for tracking the request across systems.
Was this page helpful?
āI