Skip to main content
GET
/
identities
/
{identity_id}
Get identity
curl --request GET \
  --url http://localhost:5001/identities/{identity_id} \
  --header 'X-blnk-key: <api-key>'
import requests

url = "http://localhost:5001/identities/{identity_id}"

headers = {"X-blnk-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-blnk-key': '<api-key>'}};

fetch('http://localhost:5001/identities/{identity_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_PORT => "5001",
CURLOPT_URL => "http://localhost:5001/identities/{identity_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-blnk-key: <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 := "http://localhost:5001/identities/{identity_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-blnk-key", "<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("http://localhost:5001/identities/{identity_id}")
.header("X-blnk-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:5001/identities/{identity_id}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["X-blnk-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
Use blnk.identity.get to fetch a single identity by its identity id.
1

Call the method

blnk.identity.get
response = blnk.identity.get(
  "idt_3b63c8da-af29-4cc3-ad38-df17d87456e6",
)
FieldTypeDescription
idstrIdentity ID to retrieve.
2

Use the identity details

Read response.data for profile fields, metadata, and creation time. Use the identity ID when linking balances or updating profile data.
3

Response

200 OK
{
  "identity_id": "idt_3b63c8da-af29-4cc3-ad38-df17d87456e6",
  "identity_type": "individual",
  "first_name": "Alice",
  "last_name": "Smith",
  "email_address": "alice.smith@example.com",
  "phone_number": "+1234567890",
  "nationality": "Canadian",
  "category": "customer",
  "created_at": "2024-11-26T08:36:36.238244338Z",
  "meta_data": {
    "customer_id": "CUST123456"
  }
}
FieldTypeDescription
identity_idstrUnique ID for the identity.
identity_typestrindividual or organization.
created_atstrDate and time the identity was created.
meta_datadictMetadata stored with the identity.
The response includes every profile field set on the identity.

How identities work

Linking balances and handling profile data.

View identity details

HTTP request and response schema.

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.