Skip to main content
GET
/
entities
/
{entityId}
/
insights
/
metrics
/
buro-de-credito
/
summary
Get Buró de Crédito summary
curl --request GET \
  --url https://api.syntage.com/entities/{entityId}/insights/metrics/buro-de-credito/summary \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/BuroDeCreditoSummary",
  "@id": "/entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/insights/metrics/buro-de-credito/summary",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "id": "9cc7fc78-5e84-4862-af83-c6c7022fcb41",
      "productType": "007",
      "createdAt": "2024-01-31T00:00:00+00:00",
      "scoreValue": "0676",
      "scoreCode": "007",
      "scoreReasonCodes": [
        "04"
      ],
      "externalReturnKey": "1"
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:first": "<string>",
    "hydra:next": "<string>",
    "hydra:last": "<string>"
  }
}

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
entityId
string<uuid>
required

Query Parameters

​
options[from]
string
default:2014-01-01

Filter by report creation date on or after this date

​
options[to]
string
default:now

Filter by report creation date on or before this date

Response

Buró de Crédito summary

​
@context
string
default:/contexts/BuroDeCreditoSummary
​
@id
string
Example:

"/entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/insights/metrics/buro-de-credito/summary"

​
@type
string
default:hydra:Collection
​
hydra:member
object[]
​
hydra:totalItems
integer

Total number of items found

Required range: x >= 0
Example:

1

​
hydra:view
object

Pagination information