Search profiles
curl --request POST \
--url https://{space}.{region}.api.niadra.com/v1/profiles/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "+14155550123",
"limit": 20
}
'import requests
url = "https://{space}.{region}.api.niadra.com/v1/profiles/search"
payload = {
"query": "+14155550123",
"limit": 20
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: '+14155550123', limit: 20})
};
fetch('https://{space}.{region}.api.niadra.com/v1/profiles/search', 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://{space}.{region}.api.niadra.com/v1/profiles/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '+14155550123',
'limit' => 20
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{space}.{region}.api.niadra.com/v1/profiles/search"
payload := strings.NewReader("{\n \"query\": \"+14155550123\",\n \"limit\": 20\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{space}.{region}.api.niadra.com/v1/profiles/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"+14155550123\",\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{space}.{region}.api.niadra.com/v1/profiles/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"+14155550123\",\n \"limit\": 20\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"profile_id": "0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e01",
"pseudonym": "p_7f3a91c2",
"kind": "person",
"partial": false,
"handles": [
{
"handle_id": "0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e02",
"type": "phone_e164",
"value": "+1415555****",
"scope": "",
"subject_kind": "person",
"status": "active",
"level": "V1",
"first_seen": "2021-04-06T13:20:00Z",
"last_seen": "2026-09-22T17:07:03Z"
},
{
"handle_id": "0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e03",
"type": "system_id",
"value": "48213",
"scope": "crm",
"subject_kind": "person",
"status": "active",
"level": "V4",
"first_seen": "2021-04-06T13:21:00Z",
"last_seen": "2026-09-22T17:07:03Z"
}
],
"last_seen": "2026-09-22T17:07:03Z"
}
]
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"detail": "<string>",
"request_id": "<string>",
"type": "about:blank"
}Identity and profiles
Search profiles
Finds profiles by handle, with the value in the body and never logged.
POST
/
v1
/
profiles
/
search
Search profiles
curl --request POST \
--url https://{space}.{region}.api.niadra.com/v1/profiles/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "+14155550123",
"limit": 20
}
'import requests
url = "https://{space}.{region}.api.niadra.com/v1/profiles/search"
payload = {
"query": "+14155550123",
"limit": 20
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: '+14155550123', limit: 20})
};
fetch('https://{space}.{region}.api.niadra.com/v1/profiles/search', 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://{space}.{region}.api.niadra.com/v1/profiles/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '+14155550123',
'limit' => 20
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{space}.{region}.api.niadra.com/v1/profiles/search"
payload := strings.NewReader("{\n \"query\": \"+14155550123\",\n \"limit\": 20\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{space}.{region}.api.niadra.com/v1/profiles/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"+14155550123\",\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{space}.{region}.api.niadra.com/v1/profiles/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"+14155550123\",\n \"limit\": 20\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"profile_id": "0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e01",
"pseudonym": "p_7f3a91c2",
"kind": "person",
"partial": false,
"handles": [
{
"handle_id": "0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e02",
"type": "phone_e164",
"value": "+1415555****",
"scope": "",
"subject_kind": "person",
"status": "active",
"level": "V1",
"first_seen": "2021-04-06T13:20:00Z",
"last_seen": "2026-09-22T17:07:03Z"
},
{
"handle_id": "0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e03",
"type": "system_id",
"value": "48213",
"scope": "crm",
"subject_kind": "person",
"status": "active",
"level": "V4",
"first_seen": "2021-04-06T13:21:00Z",
"last_seen": "2026-09-22T17:07:03Z"
}
],
"last_seen": "2026-09-22T17:07:03Z"
}
]
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"detail": "<string>",
"request_id": "<string>",
"type": "about:blank"
}Authorizations
sourceKeypersonToken
nia_sk_...
Body
application/json
The value travels in the body. A pseudonym (p_...) or an identifier: phones, e-mails,
WhatsApp ids and CPFs are recognized by format; opaque ids need type (and scope when scoped).
Required string length:
1 - 320Required range:
1 <= x <= 50Required string length:
1 - 256The kind of identifier. The value is classified by its format, never by the field it came from.
Available options:
phone_e164, wa_id, wa_jid, wa_lid, wa_bsuid, email, gov_id_hmac, app_user_id, system_id, org_registry_hmac, email_domain, anon_id Response
The profiles found, with handles masked by the role of the reader.
Show child attributes
Show child attributes

