Get an entity's Buró de Crédito authorizations

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

{
  "@context": "/contexts/BuroDeCreditoAuthorization",
  "@id": "/entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/datasources/mx/buro-de-credito/authorizations",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "id": "9bd4a640-9f41-4cd5-a158-20767b386ca0",
      "rfc": "PRPU800101HM2",
      "link": {
        "@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"
      },
      "authorizedAt": "2024-01-31T00:00:00+00:00",
      "authorizedUntil": "2027-01-31T00:00:00+00:00",
      "nationality": "MX",
      "birthdate": "1980-01-01",
      "firstName": "UNO",
      "firstLastName": "PRUEBA",
      "secondLastName": "PROSPECTOR",
      "address": "Jaime Balmes",
      "city": "Cd de Mexico",
      "municipality": "Miguel Hidalgo",
      "state": "CMX",
      "postalCode": "11510",
      "neighborhood": "Los morales",
      "country": "MX",
      "createdAt": "2024-01-31T00:00:00+00:00",
      "updatedAt": "2024-01-31T00:00:00+00:00",
      "exteriorNumber": "8",
      "interiorNumber": "",
      "deletedAt": "2024-01-31T00:00:00+00:00"
    }
  ],
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
    "hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

GET

entities

{entityId}

datasources

buro-de-credito

authorizations

Get an entity's Buró de Crédito authorizations

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

{
  "@context": "/contexts/BuroDeCreditoAuthorization",
  "@id": "/entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/datasources/mx/buro-de-credito/authorizations",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "id": "9bd4a640-9f41-4cd5-a158-20767b386ca0",
      "rfc": "PRPU800101HM2",
      "link": {
        "@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"
      },
      "authorizedAt": "2024-01-31T00:00:00+00:00",
      "authorizedUntil": "2027-01-31T00:00:00+00:00",
      "nationality": "MX",
      "birthdate": "1980-01-01",
      "firstName": "UNO",
      "firstLastName": "PRUEBA",
      "secondLastName": "PROSPECTOR",
      "address": "Jaime Balmes",
      "city": "Cd de Mexico",
      "municipality": "Miguel Hidalgo",
      "state": "CMX",
      "postalCode": "11510",
      "neighborhood": "Los morales",
      "country": "MX",
      "createdAt": "2024-01-31T00:00:00+00:00",
      "updatedAt": "2024-01-31T00:00:00+00:00",
      "exteriorNumber": "8",
      "interiorNumber": "",
      "deletedAt": "2024-01-31T00:00:00+00:00"
    }
  ],
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
    "hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

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

Buró de Crédito Authorizations

@context

string

default:/contexts/BuroDeCreditoAuthorization

@id

string

Example:

"/entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/datasources/mx/buro-de-credito/authorizations"

@type

string

default:hydra:Collection

hydra:member

(Person · object | Company · object)[]

Person
Company

Show child attributes

hydra:member.id

string<uuid>

required

Example:

"9bd4a640-9f41-4cd5-a158-20767b386ca0"

hydra:member.rfc

string

required

Example:

"PRPU800101HM2"

hydra:member.link

object

required

Show child attributes

hydra:member.link.@id

string<iri-reference>

Entity IRI reference

Example:

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

hydra:member.link.@type

string

default:Link

hydra:member.link.id

string<uuid>

Example:

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

hydra:member.link.type

enum<string>

The type of entity

Available options:

company,

person

Example:

"company"

hydra:member.link.taxpayer

object

Show child attributes

hydra:member.link.taxpayer.@id

string<iri-reference>

Taxpayer IRI reference

Example:

"/taxpayers/PEIC211118IS0"

hydra:member.link.taxpayer.@type

string

default:Taxpayer

hydra:member.link.taxpayer.id

string

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

hydra:member.link.taxpayer.personType

enum<string>

Available options:

physical,

legal

Example:

"physical"

hydra:member.link.taxpayer.registrationDate

string<date>

hydra:member.link.taxpayer.name

string

Taxpayer name

Required string length: 1 - 254

Example:

"Pedro Infante Cruz"

hydra:member.link.credential

object

Show child attributes

hydra:member.link.credential.@id

string<iri-reference>

SAT Credential IRI reference

Example:

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

hydra:member.link.credential.@type

string

default:Credential

hydra:member.link.credential.id

string<uuid>

Example:

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

hydra:member.link.credential.type

enum<string>

Available options:

ciec,

efirma

Example:

"ciec"

hydra:member.link.credential.rfc

string

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13

Example:

"PEIC211118IS0"

hydra:member.link.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"

hydra:member.link.credential.createdAt

string

Date and time the resource was created

Example:

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

hydra:member.link.credential.updatedAt

string

Date and time the resource was last updated

Example:

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

hydra:member.link.tags

object[]

Show child attributes

hydra:member.link.tags.@id

string<iri-reference>

Entity Tag IRI reference

Example:

"/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997"

hydra:member.link.tags.@type

string

default:EntityTag

hydra:member.link.tags.id

string<uuid>

Example:

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

hydra:member.link.tags.name

string

Example:

"Important Taxpayer"

hydra:member.link.tags.createdAt

string

Date and time the resource was created

Example:

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

hydra:member.link.tags.updatedAt

string

Date and time the resource was last updated

Example:

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

hydra:member.link.createdAt

string

Date and time the resource was created

Example:

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

hydra:member.link.updatedAt

string

Date and time the resource was last updated

Example:

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

hydra:member.authorizedAt

string<date-time>

required

Example:

"2024-01-31T00:00:00+00:00"

hydra:member.authorizedUntil

string<date-time>

required

Example:

"2027-01-31T00:00:00+00:00"

hydra:member.nationality

string

required

Example:

"MX"

hydra:member.birthdate

string<date>

required

Example:

"1980-01-01"

hydra:member.firstName

string

required

Example:

"UNO"

hydra:member.firstLastName

string

required

Example:

"PRUEBA"

hydra:member.secondLastName

string

required

Example:

"PROSPECTOR"

hydra:member.address

string

required

Example:

"Jaime Balmes"

hydra:member.city

string

required

Example:

"Cd de Mexico"

hydra:member.municipality

string

required

Example:

"Miguel Hidalgo"

hydra:member.state

string

required

Example:

"CMX"

hydra:member.postalCode

string

required

Example:

"11510"

hydra:member.neighborhood

string

required

Example:

"Los morales"

hydra:member.country

string

required

Example:

"MX"

hydra:member.createdAt

string<date-time>

required

Example:

"2024-01-31T00:00:00+00:00"

hydra:member.updatedAt

string<date-time>

required

Example:

"2024-01-31T00:00:00+00:00"

hydra:member.exteriorNumber

string

Example:

"8"

hydra:member.interiorNumber

string

Example:

""

hydra:member.deletedAt

string<date-time>

Example:

"2024-01-31T00:00:00+00:00"

hydra:view

object

Pagination information

Show child attributes

hydra:view.@id

string<iri-reference>

Current page IRI reference

hydra:view.@type

string

default:hydra:PartialCollectionView

hydra:view.hydra:next

string

Next page IRI reference. This property is omitted if there is no pagination.

Example:

"/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367"

hydra:view.hydra:last

string

Last page IRI reference. This property is omitted if there is no pagination.

Example:

"/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"

hydra:search

object

Show child attributes

hydra:search.@type

string

hydra:search.hydra:template

string

hydra:search.hydra:variableRepresentation

string

hydra:search.hydra:mapping

object[]

Show child attributes

hydra:search.hydra:mapping.@type

string

hydra:search.hydra:mapping.variable

string

hydra:search.hydra:mapping.property

string

hydra:search.hydra:mapping.required

boolean

Get a Buró de Crédito report Create a Buró de Crédito authorization

⌘I

Core Resources

Extractions

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Insights

Webhooks

Miscellaneous

Get an entity's Buró de Crédito authorizations

Authorizations

Path Parameters

Response