Add an Entity

curl --request POST \
  --url https://api.syntage.com/entities \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "type": "company",
  "name": "Syntage",
  "rfc": "XAXX010101000",
  "datasources": null,
  "identifiers": [
    {
      "country": "mx",
      "identifier": "rfc",
      "value": "XAXX010101000"
    }
  ],
  "metadata": {
    "sandbox": {}
  }
}
'

import requests

url = "https://api.syntage.com/entities"

payload = {
    "type": "company",
    "name": "Syntage",
    "rfc": "XAXX010101000",
    "datasources": None,
    "identifiers": [
        {
            "country": "mx",
            "identifier": "rfc",
            "value": "XAXX010101000"
        }
    ],
    "metadata": { "sandbox": {} }
}
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({
    type: 'company',
    name: 'Syntage',
    rfc: 'XAXX010101000',
    datasources: null,
    identifiers: [{country: 'mx', identifier: 'rfc', value: 'XAXX010101000'}],
    metadata: {sandbox: {}}
  })
};

fetch('https://api.syntage.com/entities', 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",
  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([
    'type' => 'company',
    'name' => 'Syntage',
    'rfc' => 'XAXX010101000',
    'datasources' => null,
    'identifiers' => [
        [
                'country' => 'mx',
                'identifier' => 'rfc',
                'value' => 'XAXX010101000'
        ]
    ],
    'metadata' => [
        'sandbox' => [
                
        ]
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"type\": \"company\",\n  \"name\": \"Syntage\",\n  \"rfc\": \"XAXX010101000\",\n  \"datasources\": null,\n  \"identifiers\": [\n    {\n      \"country\": \"mx\",\n      \"identifier\": \"rfc\",\n      \"value\": \"XAXX010101000\"\n    }\n  ],\n  \"metadata\": {\n    \"sandbox\": {}\n  }\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")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"company\",\n  \"name\": \"Syntage\",\n  \"rfc\": \"XAXX010101000\",\n  \"datasources\": null,\n  \"identifiers\": [\n    {\n      \"country\": \"mx\",\n      \"identifier\": \"rfc\",\n      \"value\": \"XAXX010101000\"\n    }\n  ],\n  \"metadata\": {\n    \"sandbox\": {}\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/entities")

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  \"type\": \"company\",\n  \"name\": \"Syntage\",\n  \"rfc\": \"XAXX010101000\",\n  \"datasources\": null,\n  \"identifiers\": [\n    {\n      \"country\": \"mx\",\n      \"identifier\": \"rfc\",\n      \"value\": \"XAXX010101000\"\n    }\n  ],\n  \"metadata\": {\n    \"sandbox\": {}\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "5c7c3ac7-5c49-49f4-be0a-7824bfcf3060",
  "name": "Syntage",
  "@context": "/contexts/EntityAddedResponse",
  "rfc": "XAXX010101000",
  "onboardingUrl": "https://onboarding.syntage.com/onboarding/018f3f8f-4538-7bbb-b432-9e97e34a564a"
}

{
  "@context": "/contexts/ConstraintViolation",
  "@type": "ConstraintViolation",
  "hydra:title": "An error occurred",
  "hydra:description": "exampleField: This value should not be blank.",
  "violations": [
    {
      "propertyPath": "exampleField",
      "message": "This value should not be blank.",
      "code": "rfc_valid_no_name_on_file"
    }
  ]
}

{
  "message": "<string>"
}

Entities

Add an Entity

Add an entity to your organization.

If datasources contains one or more datasources, Syntage creates first-time extractions for the selected datasources. When a selected datasource has first-time scheduler rules, those rules determine which extractors and options are used. For selected datasources not covered by first-time scheduler rules, Syntage creates first-time extractions for the datasource’s available extractors using the options from the request, or the extractor defaults.

Omit datasources or send an empty array to create the entity without starting extractions.

name is optional when you provide a valid RFC. If omitted or null, Syntage resolves the entity’s legal name from taxpayer data during creation and stores that name on the entity. If no name is available for the RFC, the request fails with a validation error on name using the code rfc_valid_no_name_on_file; retry with an explicit name to create the entity.

POST

entities

Add an Entity

curl --request POST \
  --url https://api.syntage.com/entities \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "type": "company",
  "name": "Syntage",
  "rfc": "XAXX010101000",
  "datasources": null,
  "identifiers": [
    {
      "country": "mx",
      "identifier": "rfc",
      "value": "XAXX010101000"
    }
  ],
  "metadata": {
    "sandbox": {}
  }
}
'

import requests

url = "https://api.syntage.com/entities"

payload = {
    "type": "company",
    "name": "Syntage",
    "rfc": "XAXX010101000",
    "datasources": None,
    "identifiers": [
        {
            "country": "mx",
            "identifier": "rfc",
            "value": "XAXX010101000"
        }
    ],
    "metadata": { "sandbox": {} }
}
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({
    type: 'company',
    name: 'Syntage',
    rfc: 'XAXX010101000',
    datasources: null,
    identifiers: [{country: 'mx', identifier: 'rfc', value: 'XAXX010101000'}],
    metadata: {sandbox: {}}
  })
};

fetch('https://api.syntage.com/entities', 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",
  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([
    'type' => 'company',
    'name' => 'Syntage',
    'rfc' => 'XAXX010101000',
    'datasources' => null,
    'identifiers' => [
        [
                'country' => 'mx',
                'identifier' => 'rfc',
                'value' => 'XAXX010101000'
        ]
    ],
    'metadata' => [
        'sandbox' => [
                
        ]
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"type\": \"company\",\n  \"name\": \"Syntage\",\n  \"rfc\": \"XAXX010101000\",\n  \"datasources\": null,\n  \"identifiers\": [\n    {\n      \"country\": \"mx\",\n      \"identifier\": \"rfc\",\n      \"value\": \"XAXX010101000\"\n    }\n  ],\n  \"metadata\": {\n    \"sandbox\": {}\n  }\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")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"company\",\n  \"name\": \"Syntage\",\n  \"rfc\": \"XAXX010101000\",\n  \"datasources\": null,\n  \"identifiers\": [\n    {\n      \"country\": \"mx\",\n      \"identifier\": \"rfc\",\n      \"value\": \"XAXX010101000\"\n    }\n  ],\n  \"metadata\": {\n    \"sandbox\": {}\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/entities")

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  \"type\": \"company\",\n  \"name\": \"Syntage\",\n  \"rfc\": \"XAXX010101000\",\n  \"datasources\": null,\n  \"identifiers\": [\n    {\n      \"country\": \"mx\",\n      \"identifier\": \"rfc\",\n      \"value\": \"XAXX010101000\"\n    }\n  ],\n  \"metadata\": {\n    \"sandbox\": {}\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "5c7c3ac7-5c49-49f4-be0a-7824bfcf3060",
  "name": "Syntage",
  "@context": "/contexts/EntityAddedResponse",
  "rfc": "XAXX010101000",
  "onboardingUrl": "https://onboarding.syntage.com/onboarding/018f3f8f-4538-7bbb-b432-9e97e34a564a"
}

{
  "@context": "/contexts/ConstraintViolation",
  "@type": "ConstraintViolation",
  "hydra:title": "An error occurred",
  "hydra:description": "exampleField: This value should not be blank.",
  "violations": [
    {
      "propertyPath": "exampleField",
      "message": "This value should not be blank.",
      "code": "rfc_valid_no_name_on_file"
    }
  ]
}

{
  "message": "<string>"
}

Authorizations

X-API-Key

string

header

required

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

Body

application/json

type

enum<string>

required

write-only

Entity type, either company or person

Available options:

company,

person

Example:

"company"

name

string | null

write-only

Entity name. Optional when rfc is provided; when omitted or null, Syntage resolves the legal name from taxpayer data during entity creation.

Example:

"Syntage"

rfc

string

write-only

Entity RFC if known; if it is not input here, extractions that require the RFC wait until the entity provides the RFC

Example:

"XAXX010101000"

datasources

object[]

write-only

Datasources to extract for the new entity

Show child attributes

Example:

null

identifiers

object[]

write-only

Optional country-specific identifiers to add to the entity

Show child attributes

metadata

object

write-only

Optional entity metadata. In sandbox, use sandbox.taxRegime to shape the simulated fiscal profile; omit it to select a stable profile automatically. Production accepts and persists this metadata but does not interpret it because sandbox extractors are unavailable there.

Show child attributes

Response

Add entity resource response

string

required

Example:

"5c7c3ac7-5c49-49f4-be0a-7824bfcf3060"

name

string

required

Example:

"Syntage"

@context

string

default:/contexts/EntityAddedResponse

rfc

string

Example:

"XAXX010101000"

onboardingUrl

string

Onboarding URL returned when Syntage still needs input from the entity to complete setup, such as a missing rfc or a required credential. If the request already provides everything Syntage needs to resolve the entity (for example, a valid rfc), this field is omitted or empty because no onboarding step is required.

Example:

"https://onboarding.syntage.com/onboarding/018f3f8f-4538-7bbb-b432-9e97e34a564a"

⌘I

Core Resources

Other Resources

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Datasource: BIL

Datasource: Infonavit

Insights

Reports

Webhooks

Add an Entity

Authorizations

Body

Response