Retrieve an Entity

curl --request GET \
  --url https://api.syntage.com/entities/{entityId} \
  --header 'X-API-Key: <api-key>'

{
  "@context": "/contexts/Entity",
  "@id": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "Link",
  "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
  "type": "company",
  "taxpayer": {
    "@id": "/taxpayers/PEIC211118IS0",
    "@type": "Taxpayer",
    "id": "PEIC211118IS0",
    "personType": "physical",
    "registrationDate": "2023-12-25",
    "name": "Pedro Infante Cruz"
  },
  "credential": {
    "@id": "/credentials/91106968-1abd-4d64-85c1-4e73d96fb997",
    "@type": "Credential",
    "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
    "type": "ciec",
    "rfc": "PEIC211118IS0",
    "status": "pending",
    "createdAt": "2020-01-01T12:15:00.000Z",
    "updatedAt": "2020-01-01T12:15:00.000Z"
  },
  "tags": [
    {
      "@id": "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "EntityTag",
      "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
      "name": "Important Taxpayer",
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}

GET

entities

{entityId}

Retrieve an Entity

curl --request GET \
  --url https://api.syntage.com/entities/{entityId} \
  --header 'X-API-Key: <api-key>'

{
  "@context": "/contexts/Entity",
  "@id": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "Link",
  "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
  "type": "company",
  "taxpayer": {
    "@id": "/taxpayers/PEIC211118IS0",
    "@type": "Taxpayer",
    "id": "PEIC211118IS0",
    "personType": "physical",
    "registrationDate": "2023-12-25",
    "name": "Pedro Infante Cruz"
  },
  "credential": {
    "@id": "/credentials/91106968-1abd-4d64-85c1-4e73d96fb997",
    "@type": "Credential",
    "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
    "type": "ciec",
    "rfc": "PEIC211118IS0",
    "status": "pending",
    "createdAt": "2020-01-01T12:15:00.000Z",
    "updatedAt": "2020-01-01T12:15:00.000Z"
  },
  "tags": [
    {
      "@id": "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "EntityTag",
      "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
      "name": "Important Taxpayer",
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}

Authorizations

X-API-Key

string

header

required

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

Path Parameters

entityId

string<uuid>

required

Response

Entity resource response

@context

string

default:/contexts/Entity

@id

string<iri-reference>

Entity IRI reference

Example:

"/entities/91106968-1abd-4d64-85c1-4e73d96fb997"

@type

string

default:Link

string<uuid>

Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

type

enum<string>

The type of entity

Available options:

company,

person

Example:

"company"

taxpayer

object

Show child attributes

taxpayer.@id

string<iri-reference>

Taxpayer IRI reference

Example:

"/taxpayers/PEIC211118IS0"

taxpayer.@type

string

default:Taxpayer

taxpayer.id

string

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

taxpayer.personType

enum<string>

Available options:

physical,

legal

Example:

"physical"

taxpayer.registrationDate

string<date>

taxpayer.name

string

Taxpayer name

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

credential

object

Show child attributes

credential.@id

string<iri-reference>

SAT Credential IRI reference

Example:

"/credentials/91106968-1abd-4d64-85c1-4e73d96fb997"

credential.@type

string

default:Credential

credential.id

string<uuid>

Example:

"91106968-1abd-4d64-85c1-4e73d96fb997"

credential.type

enum<string>

Available options:

ciec,

efirma

Example:

"ciec"

credential.rfc

string

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

credential.status

enum<string>

The initial status is always pending. After a few seconds, it changes to valid or invalid depending on SAT's response to our login attempt.

Available options:

pending,

valid,

invalid,

deactivated,

error

Example:

"pending"

credential.createdAt

string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

credential.updatedAt

string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"

Core Resources

Extractions

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Insights

Webhooks

Miscellaneous

Retrieve an Entity

Authorizations

Path Parameters

Response