Get a Buró de Crédito authorization

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

import requests

url = "https://api.syntage.com/datasources/mx/buro-de-credito/authorizations/{id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.syntage.com/datasources/mx/buro-de-credito/authorizations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.syntage.com/datasources/mx/buro-de-credito/authorizations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syntage.com/datasources/mx/buro-de-credito/authorizations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/datasources/mx/buro-de-credito/authorizations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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": "Priority Entity",
        "color": "#22c558",
        "createdAt": "2020-01-01T12:15:00.000Z",
        "updatedAt": "2020-01-01T12:15:00.000Z"
      }
    ],
    "isFavorite": true,
    "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",
  "validityYears": 3,
  "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",
  "@context": "<unknown>",
  "@id": "<unknown>",
  "middleName": "DOS",
  "exteriorNumber": "8",
  "interiorNumber": "",
  "email": "person@example.com",
  "origin": "external",
  "isValid": true,
  "deletedAt": "2024-01-31T00:00:00+00:00"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

datasources

buro-de-credito

authorizations

{id}

Get a Buró de Crédito authorization

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

import requests

url = "https://api.syntage.com/datasources/mx/buro-de-credito/authorizations/{id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.syntage.com/datasources/mx/buro-de-credito/authorizations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.syntage.com/datasources/mx/buro-de-credito/authorizations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syntage.com/datasources/mx/buro-de-credito/authorizations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/datasources/mx/buro-de-credito/authorizations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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": "Priority Entity",
        "color": "#22c558",
        "createdAt": "2020-01-01T12:15:00.000Z",
        "updatedAt": "2020-01-01T12:15:00.000Z"
      }
    ],
    "isFavorite": true,
    "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",
  "validityYears": 3,
  "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",
  "@context": "<unknown>",
  "@id": "<unknown>",
  "middleName": "DOS",
  "exteriorNumber": "8",
  "interiorNumber": "",
  "email": "person@example.com",
  "origin": "external",
  "isValid": true,
  "deletedAt": "2024-01-31T00:00:00+00:00"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

X-API-Key

string

header

required

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

Path Parameters

string<uuid>

required

Response

Buró de Crédito Authorization

Person
Company

string<uuid>

required

Unique authorization ID

Example:

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

rfc

string

required

RFC authorized for Buró de Crédito report requests

Example:

"PRPU800101HM2"

link

object

required

Entity associated with the authorization

Show child attributes

authorizedAt

string<date-time>

required

Date and time when authorization was granted

Example:

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

authorizedUntil

string<date-time>

required

Date and time when authorization expires

Example:

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

validityYears

enum<integer>

required

Term, in years, that this authorization was signed under. authorizedUntil is this many years after authorizedAt.

Available options:

1,

2,

3

Example:

3

nationality

string

required

Two-letter nationality code

Example:

"MX"

birthdate

string<date>

required

Person birth date

Example:

"1980-01-01"

firstName

string

required

Person first name

Example:

"UNO"

firstLastName

string

required

Person first last name

Example:

"PRUEBA"

secondLastName

string

required

Person second last name

Example:

"PROSPECTOR"

address

string

required

Street name used for the authorization address

Example:

"Jaime Balmes"

city

string

required

City used for the authorization address

Example:

"Cd de Mexico"

municipality

string

required

Municipality or borough used for the authorization address

Example:

"Miguel Hidalgo"

state

string

required

Buró de Crédito state code for the authorization address

Example:

"CMX"

postalCode

string

required

Five-digit postal code used for the authorization address

Example:

"11510"

neighborhood

string

required

Neighborhood used for the authorization address

Example:

"Los morales"

country

string

required

Two-letter country code for the authorization address

Example:

"MX"

createdAt

string<date-time>

required

Date and time when the authorization was created

Example:

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

updatedAt

string<date-time>

required

Date and time when the authorization was last updated

Example:

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

@context

any

@id

any

middleName

string | null

Person middle name

Example:

"DOS"

exteriorNumber

string | null

Exterior number used for the authorization address

Example:

"8"

interiorNumber

string | null

Interior number used for the authorization address

Example:

""

string | null

Email address associated with the authorization when available

Example:

"person@example.com"

origin

enum<string>

How the authorization was created

Available options:

external,

onboarding

Example:

"external"

isValid

boolean

Whether the authorization has not expired

Example:

true

deletedAt

string<date-time> | null

Date and time when the authorization was deleted

Example:

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

Core Resources

Other Resources

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Datasource: BIL

Datasource: Infonavit

Insights

Reports

Webhooks

Get a Buró de Crédito authorization

Authorizations

Path Parameters

Response