curl --request GET \
--url https://api.yorlet.com/v1/references \
--header 'Authorization: <api-key>'{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "reference",
"application": "<string>",
"automatic_reference": {
"enabled": true,
"last_error": "<string>",
"outcome": "<string>",
"provider_data": {
"advance_rent": {
"affordability": {
"percentage": 123,
"status": "<string>"
},
"credit_score": 123,
"notes": [
{
"created": 123,
"message": "<string>"
}
],
"progress": 123,
"sanctions_passed": true
},
"type": "advance_rent"
},
"provider": "advance_rent",
"status": "<string>"
},
"completed_at": 123,
"customer": "<string>",
"outcome": "accept",
"reference_pdf": "<string>",
"status": "pending",
"type": "customer",
"account": "<string>",
"deleted": false,
"metadata": {}
}
]
}curl --request GET \
--url https://api.yorlet.com/v1/references \
--header 'Authorization: <api-key>'{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "reference",
"application": "<string>",
"automatic_reference": {
"enabled": true,
"last_error": "<string>",
"outcome": "<string>",
"provider_data": {
"advance_rent": {
"affordability": {
"percentage": 123,
"status": "<string>"
},
"credit_score": 123,
"notes": [
{
"created": 123,
"message": "<string>"
}
],
"progress": 123,
"sanctions_passed": true
},
"type": "advance_rent"
},
"provider": "advance_rent",
"status": "<string>"
},
"completed_at": 123,
"customer": "<string>",
"outcome": "accept",
"reference_pdf": "<string>",
"status": "pending",
"type": "customer",
"account": "<string>",
"deleted": false,
"metadata": {}
}
]
}API Key authentication. Use "Bearer YOUR_API_KEY".
A object with a data property that contains an array of references.
Was this page helpful?