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

Authorizations

​
X-API-Key
string
header
required

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

Body

application/json
​
name
string
required

The name of the entity

Example:

"Syntage"

​
type
enum<string>
required

The type of entity be it a company or person

Available options:
company,
person
Example:

"company"

​
rfc
string

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[]

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"