Skip to main content
POST
Add an Entity

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. When rfc is provided, the type must match it; a 12-character RFC belongs to a company and a 13-character RFC to a 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:

"SAT970701NN3"

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

metadata
object
write-only

Optional entity metadata. In sandbox, use sandbox.taxRegime to shape the simulated fiscal profile and sandbox.backgroundCheck to shape the simulated background check findings; omit them to let sandbox decide stably per entity. Production accepts and persists this metadata but does not interpret it because sandbox extractors are unavailable there.

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 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. Onboarding URLs do not expire.

Example:

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