Create a link
curl --request POST \
--url https://{space}.{region}.api.niadra.com/v1/identity/links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"person": {
"type": "phone_e164",
"value": "+14155550123"
},
"organization": {
"type": "system_id",
"value": "ACC-2201",
"scope": "crm",
"subject_kind": "account"
},
"role": "buyer",
"method": "system_import",
"can_see_contacts": false
}
'import requests
url = "https://{space}.{region}.api.niadra.com/v1/identity/links"
payload = {
"person": {
"type": "phone_e164",
"value": "+14155550123"
},
"organization": {
"type": "system_id",
"value": "ACC-2201",
"scope": "crm",
"subject_kind": "account"
},
"role": "buyer",
"method": "system_import",
"can_see_contacts": False
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
person: {type: 'phone_e164', value: '+14155550123'},
organization: {type: 'system_id', value: 'ACC-2201', scope: 'crm', subject_kind: 'account'},
role: 'buyer',
method: 'system_import',
can_see_contacts: false
})
};
fetch('https://{space}.{region}.api.niadra.com/v1/identity/links', 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/identity/links",
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([
'person' => [
'type' => 'phone_e164',
'value' => '+14155550123'
],
'organization' => [
'type' => 'system_id',
'value' => 'ACC-2201',
'scope' => 'crm',
'subject_kind' => 'account'
],
'role' => 'buyer',
'method' => 'system_import',
'can_see_contacts' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{space}.{region}.api.niadra.com/v1/identity/links"
payload := strings.NewReader("{\n \"person\": {\n \"type\": \"phone_e164\",\n \"value\": \"+14155550123\"\n },\n \"organization\": {\n \"type\": \"system_id\",\n \"value\": \"ACC-2201\",\n \"scope\": \"crm\",\n \"subject_kind\": \"account\"\n },\n \"role\": \"buyer\",\n \"method\": \"system_import\",\n \"can_see_contacts\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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/identity/links")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"person\": {\n \"type\": \"phone_e164\",\n \"value\": \"+14155550123\"\n },\n \"organization\": {\n \"type\": \"system_id\",\n \"value\": \"ACC-2201\",\n \"scope\": \"crm\",\n \"subject_kind\": \"account\"\n },\n \"role\": \"buyer\",\n \"method\": \"system_import\",\n \"can_see_contacts\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{space}.{region}.api.niadra.com/v1/identity/links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"person\": {\n \"type\": \"phone_e164\",\n \"value\": \"+14155550123\"\n },\n \"organization\": {\n \"type\": \"system_id\",\n \"value\": \"ACC-2201\",\n \"scope\": \"crm\",\n \"subject_kind\": \"account\"\n },\n \"role\": \"buyer\",\n \"method\": \"system_import\",\n \"can_see_contacts\": false\n}"
response = http.request(request)
puts response.read_body{
"link_id": "0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e08",
"person_handle_id": "0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e02",
"org_handle_id": "0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e05",
"role": "buyer",
"can_see_contacts": false,
"valid_from": "2026-09-22T17:10:00Z",
"valid_to": null
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"detail": "<string>",
"request_id": "<string>",
"type": "about:blank"
}Identity and profiles
Create a link
Links a person to an account or partner, with a role and a validity period.
POST
/
v1
/
identity
/
links
Create a link
curl --request POST \
--url https://{space}.{region}.api.niadra.com/v1/identity/links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"person": {
"type": "phone_e164",
"value": "+14155550123"
},
"organization": {
"type": "system_id",
"value": "ACC-2201",
"scope": "crm",
"subject_kind": "account"
},
"role": "buyer",
"method": "system_import",
"can_see_contacts": false
}
'import requests
url = "https://{space}.{region}.api.niadra.com/v1/identity/links"
payload = {
"person": {
"type": "phone_e164",
"value": "+14155550123"
},
"organization": {
"type": "system_id",
"value": "ACC-2201",
"scope": "crm",
"subject_kind": "account"
},
"role": "buyer",
"method": "system_import",
"can_see_contacts": False
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
person: {type: 'phone_e164', value: '+14155550123'},
organization: {type: 'system_id', value: 'ACC-2201', scope: 'crm', subject_kind: 'account'},
role: 'buyer',
method: 'system_import',
can_see_contacts: false
})
};
fetch('https://{space}.{region}.api.niadra.com/v1/identity/links', 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/identity/links",
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([
'person' => [
'type' => 'phone_e164',
'value' => '+14155550123'
],
'organization' => [
'type' => 'system_id',
'value' => 'ACC-2201',
'scope' => 'crm',
'subject_kind' => 'account'
],
'role' => 'buyer',
'method' => 'system_import',
'can_see_contacts' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{space}.{region}.api.niadra.com/v1/identity/links"
payload := strings.NewReader("{\n \"person\": {\n \"type\": \"phone_e164\",\n \"value\": \"+14155550123\"\n },\n \"organization\": {\n \"type\": \"system_id\",\n \"value\": \"ACC-2201\",\n \"scope\": \"crm\",\n \"subject_kind\": \"account\"\n },\n \"role\": \"buyer\",\n \"method\": \"system_import\",\n \"can_see_contacts\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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/identity/links")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"person\": {\n \"type\": \"phone_e164\",\n \"value\": \"+14155550123\"\n },\n \"organization\": {\n \"type\": \"system_id\",\n \"value\": \"ACC-2201\",\n \"scope\": \"crm\",\n \"subject_kind\": \"account\"\n },\n \"role\": \"buyer\",\n \"method\": \"system_import\",\n \"can_see_contacts\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{space}.{region}.api.niadra.com/v1/identity/links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"person\": {\n \"type\": \"phone_e164\",\n \"value\": \"+14155550123\"\n },\n \"organization\": {\n \"type\": \"system_id\",\n \"value\": \"ACC-2201\",\n \"scope\": \"crm\",\n \"subject_kind\": \"account\"\n },\n \"role\": \"buyer\",\n \"method\": \"system_import\",\n \"can_see_contacts\": false\n}"
response = http.request(request)
puts response.read_body{
"link_id": "0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e08",
"person_handle_id": "0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e02",
"org_handle_id": "0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e05",
"role": "buyer",
"can_see_contacts": false,
"valid_from": "2026-09-22T17:10:00Z",
"valid_to": null
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"detail": "<string>",
"request_id": "<string>",
"type": "about:blank"
}Authorizations
sourceKeypersonToken
nia_sk_...
Headers
Required. Kept 24 hours with the hash of the body: a retry with the same key returns the first answer, and the same key with a different body returns 409 conflict.
Required string length:
1 - 256Body
application/json
An identifier of a subject in some channel or system: a phone, an e-mail, a CRM id.
Show child attributes
Show child attributes
An identifier of a subject in some channel or system: a phone, an e-mail, a CRM id.
Show child attributes
Show child attributes
buyer, driver, broker, technical_contact, owner...
Required string length:
1 - 256Available options:
system_import, co_occurrence, declared, login 
