Skip to main content
POST
/
entities
/
{entityId}
/
identifiers
Add an entity identifier
curl --request POST \
  --url https://api.syntage.com/entities/{entityId}/identifiers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "country": "mx",
  "identifier": "rfc",
  "value": "XAXX010101000"
}
'
import requests

url = "https://api.syntage.com/entities/{entityId}/identifiers"

payload = {
"country": "mx",
"identifier": "rfc",
"value": "XAXX010101000"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({country: 'mx', identifier: 'rfc', value: 'XAXX010101000'})
};

fetch('https://api.syntage.com/entities/{entityId}/identifiers', 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://api.syntage.com/entities/{entityId}/identifiers",
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([
'country' => 'mx',
'identifier' => 'rfc',
'value' => 'XAXX010101000'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.syntage.com/entities/{entityId}/identifiers"

payload := strings.NewReader("{\n \"country\": \"mx\",\n \"identifier\": \"rfc\",\n \"value\": \"XAXX010101000\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
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://api.syntage.com/entities/{entityId}/identifiers")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"country\": \"mx\",\n \"identifier\": \"rfc\",\n \"value\": \"XAXX010101000\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/entities/{entityId}/identifiers")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"country\": \"mx\",\n \"identifier\": \"rfc\",\n \"value\": \"XAXX010101000\"\n}"

response = http.request(request)
puts response.read_body
{
  "@id": "/.well-known/genid/78c595ac88fa9659fa80",
  "@type": "EntityIdentifier",
  "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
  "link": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "country": "mx",
  "identifier": "rfc",
  "value": "XAXX010101000",
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}
{
"message": "<string>"
}
{
"message": "<string>"
}
{
"message": "<string>"
}

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

entityId
string<uuid>
required

Body

application/json
country
enum<string>
required
write-only

Country that issued the identifier

Available options:
mx
Example:

"mx"

identifier
enum<string>
required
write-only

Kind of identifier to add to the entity

Available options:
curp,
rfc
Example:

"rfc"

value
string
required
write-only

Identifier value

Example:

"XAXX010101000"

Response

Entity identifier resource response

@id
string<iri-reference>

Entity identifier IRI reference

Example:

"/.well-known/genid/78c595ac88fa9659fa80"

@type
string
default:EntityIdentifier

JSON-LD resource type

id
string<uuid>
Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

Entity IRI reference

Example:

"/entities/91106968-1abd-4d64-85c1-4e73d96fb997"

country
enum<string>

Country that issued the identifier

Available options:
mx
Example:

"mx"

identifier
enum<string>

Kind of identifier for the entity

Available options:
curp,
rfc
Example:

"rfc"

value
string

Identifier value

Example:

"XAXX010101000"

createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"