curl --request GET \
--url https://api.yapily.com/hosted/consent-requests/{consentRequestId} \
--header 'Authorization: Basic <encoded-value>'{
"meta": {
"tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0"
},
"data": {
"consentRequestId": "507e515f-c22d-4bab-9801-606c94e7f749",
"consentId": "b22a1fe6-1e91-45b3-8ba0-6fdb1708e7bd",
"userId": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d",
"applicationUserId": "string",
"applicationId": "64949de6-6510-4d70-9500-d4aa094c506c",
"institutionIdentifiers": {
"institutionId": "modelo-sandbox",
"institutionCountryCode": "GB"
},
"userSettings": {
"language": "en",
"location": "GB"
},
"redirectUrl": "https://tpp-application.com/",
"createdAt": "2024-09-13T11:14:04.766Z",
"authorisationExpiresAt": "2024-10-10T11:36:54.887Z",
"status": "AUTHORIZED",
"phases": [
{
"phaseName": "INITIATED",
"phaseCreatedAt": "2024-09-11T16:19:59.707Z"
},
{
"phaseName": "INSTITUTION_SUBMITTED",
"phaseCreatedAt": "2024-09-11T16:20:19.097Z"
},
{
"phaseName": "AUTHORISATION_INITIATED",
"phaseCreatedAt": "2024-09-11T16:20:47.077Z"
},
{
"phaseName": "AUTHORISATION_CREATED",
"phaseCreatedAt": "2024-09-11T16:20:48.212Z"
},
{
"phaseName": "CONSENT_POLLING_STARTED",
"phaseCreatedAt": "2024-09-11T16:20:57.654Z"
},
{
"phaseName": "CONSENT_POLLING_ENDED",
"phaseCreatedAt": "2024-09-11T16:20:58.288Z"
},
{
"phaseName": "AUTHORISED",
"phaseCreatedAt": "2024-09-11T16:20:58.288Z"
},
{
"phaseName": "FINISHED",
"phaseCreatedAt": "2024-09-11T16:20:58.288Z"
}
],
"consentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6Im1vZGVsby1zYW5kYm94IiwiQ09OU0VOVCI6IjU2YTQyMjQ0LTQxNGEtNGI1Mi04YzRmLTRhZDJhNTBlODJmZSIsIkFQUExJQ0FUSU9OX1VTRVJfSUQiOiJtb2ZlLTIiLCJVU0VSIjoiY2E0MTJmZGYtNWEzMC00M2EyLTg4YjctNTk2NGEyNGE4ZTU1In0.gorwpnUjSr5dzQJLR32M2geWOj7yK9xMsZmq27ssY9xP_xGmWfUL_aqVHYyQ4r5KWw6Xb6RjvO839st8chJLtg"
}
}Used to get details of a hosted consent request
curl --request GET \
--url https://api.yapily.com/hosted/consent-requests/{consentRequestId} \
--header 'Authorization: Basic <encoded-value>'{
"meta": {
"tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0"
},
"data": {
"consentRequestId": "507e515f-c22d-4bab-9801-606c94e7f749",
"consentId": "b22a1fe6-1e91-45b3-8ba0-6fdb1708e7bd",
"userId": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d",
"applicationUserId": "string",
"applicationId": "64949de6-6510-4d70-9500-d4aa094c506c",
"institutionIdentifiers": {
"institutionId": "modelo-sandbox",
"institutionCountryCode": "GB"
},
"userSettings": {
"language": "en",
"location": "GB"
},
"redirectUrl": "https://tpp-application.com/",
"createdAt": "2024-09-13T11:14:04.766Z",
"authorisationExpiresAt": "2024-10-10T11:36:54.887Z",
"status": "AUTHORIZED",
"phases": [
{
"phaseName": "INITIATED",
"phaseCreatedAt": "2024-09-11T16:19:59.707Z"
},
{
"phaseName": "INSTITUTION_SUBMITTED",
"phaseCreatedAt": "2024-09-11T16:20:19.097Z"
},
{
"phaseName": "AUTHORISATION_INITIATED",
"phaseCreatedAt": "2024-09-11T16:20:47.077Z"
},
{
"phaseName": "AUTHORISATION_CREATED",
"phaseCreatedAt": "2024-09-11T16:20:48.212Z"
},
{
"phaseName": "CONSENT_POLLING_STARTED",
"phaseCreatedAt": "2024-09-11T16:20:57.654Z"
},
{
"phaseName": "CONSENT_POLLING_ENDED",
"phaseCreatedAt": "2024-09-11T16:20:58.288Z"
},
{
"phaseName": "AUTHORISED",
"phaseCreatedAt": "2024-09-11T16:20:58.288Z"
},
{
"phaseName": "FINISHED",
"phaseCreatedAt": "2024-09-11T16:20:58.288Z"
}
],
"consentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6Im1vZGVsby1zYW5kYm94IiwiQ09OU0VOVCI6IjU2YTQyMjQ0LTQxNGEtNGI1Mi04YzRmLTRhZDJhNTBlODJmZSIsIkFQUExJQ0FUSU9OX1VTRVJfSUQiOiJtb2ZlLTIiLCJVU0VSIjoiY2E0MTJmZGYtNWEzMC00M2EyLTg4YjctNTk2NGEyNGE4ZTU1In0.gorwpnUjSr5dzQJLR32M2geWOj7yK9xMsZmq27ssY9xP_xGmWfUL_aqVHYyQ4r5KWw6Xb6RjvO839st8chJLtg"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.yapily.com/llms.txt
Use this file to discover all available pages before exploring further.
Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.
The sub-application ID to which event type is being subscribed to
Unique Identifier of the consent request
Was this page helpful?