Skip to main content
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 '
{
  "name": "Syntage",
  "type": "company",
  "rfc": "XAXX010101000",
  "datasources": null
}
'
{
  "id": "5c7c3ac7-5c49-49f4-be0a-7824bfcf3060",
  "name": "Syntage",
  "@context": "/contexts/EntityAddedResponse",
  "rfc": "XAXX010101000",
  "onboardingUrl": "https://registro.syntage.com/onboarding/018f3f8f-4538-7bbb-b432-9e97e34a564a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.syntage.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

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

Body

application/json
​
name
string
required
write-only

The name of the entity

Example:

"Syntage"

​
type
enum<string>
required
write-only

The type of entity be it a company or person

Available options:
company,
person
Example:

"company"

​
rfc
string
write-only

The entity's RFC if known. If it is not input here, any extractions that require the RFC will be in waiting status until the Entity provides the RFC.

Example:

"XAXX010101000"

​
datasources
object[]
write-only

The datasources that should be extracted for the new entity.

Example:

null

Response

Add entity resource response

​
id
string
required
Example:

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

​
name
string
required
Example:

"Syntage"

​
@context
string
default:/contexts/EntityAddedResponse
​
rfc
string
Example:

"XAXX010101000"

​
onboardingUrl
string

The onboarding URL if adding the entity requires input from the entity

Example:

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