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,
  "identifiers": [
    {
      "country": "mx",
      "identifier": "rfc",
      "value": "XAXX010101000"
    }
  ]
}
'
{
  "id": "5c7c3ac7-5c49-49f4-be0a-7824bfcf3060",
  "name": "Syntage",
  "@context": "/contexts/EntityAddedResponse",
  "rfc": "XAXX010101000",
  "onboardingUrl": "https://onboarding.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
write-only

Entity name

Example:

"Syntage"

​
type
enum<string>
required
write-only

Entity type, either company or person

Available options:
company,
person
Example:

"company"

​
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

Example:

null

​
identifiers
object[]
write-only

Optional country-specific identifiers to add to the entity

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

Onboarding URL returned when adding the entity requires input from the entity

Example:

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