Skip to main content
Hosted Pages is available as a Beta version. Please contact your Customer Success Manager if you would like to access it.

​
Introduction

Hosted data consent statuses and phases are used to track the progress of a consent request made using Yapily Hosted Pages for data access. This guide explains the differences between the status and phases fields in the GET /hosted/consent-requests response. The following example shows the key fields from a response of the GET /hosted/consent-requests/ endpoint. For brevity, only the phases and consentStatus fields are included. 
{
  ...
  "data": {
    ...
    "consentStatus": "AUTHORIZED",
    "phases": [
      {
        "phaseName": "INITIATED",
        "phaseCreatedAt": "2023-05-10T07:56:54.887Z"
      },
      {
        "phaseName": "INSTITUTION_SUBMITTED",
        "phaseCreatedAt": "2023-05-10T07:57:02.123Z"
      },
      {
        "phaseName": "AUTHORISATION_INITIATED",
        "phaseCreatedAt": "2023-05-10T07:57:05.123Z"
      },
      {
        "phaseName": "AUTHORISATION_CREATED",
        "phaseCreatedAt": "2023-05-10T07:57:06.637Z"
      },
      {
        "phaseName": "CONSENT_POLLING_STARTED",
        "phaseCreatedAt": "2023-05-10T07:57:07.654Z"
      },
      {
        "phaseName": "CONSENT_POLLING_ENDED",
        "phaseCreatedAt": "2023-05-10T07:57:10.288Z"
      },
      {
        "phaseName": "AUTHORISED",
        "phaseCreatedAt": "2023-05-10T07:57:10.637Z"
      },
      {
        "phaseName": "FINISHED",
        "phaseCreatedAt": "2023-05-10T07:57:11.867Z"
      }
    ]
    ...
  }
}
The phases array records the chronological sequence of phases that the consent request has gone through. The consentStatus field indicates the current status of the consent.

​
Mapping Between Status and Phases

As phases are recorded for every step that a consent request goes through, they provide a more detailed view of the progress. Therefore, multiple phases can map to a single status. The table below provides a mapping of the phases to the consent statuses:
Phase NamePhase DescriptionStatus
INITIATEDProcess initiatedPENDING
INSTITUTION_SUBMITTEDConsent institution submittedPENDING
AUTHORISATION_INITIATEDAll details required for consent initiation have been collectedPENDING
AUTHORISATION_CREATEDConsent authorisation request created with Institution, awaiting authorisation completionPENDING
AUTHORISATION_FAILEDConsent authorisation failed and will not proceed furtherFAILED
AUTHORISATION_REJECTEDConsent Authorisation request rejected by Institution and will not proceed furtherFAILED
DECOUPLED_AUTHORISATIONFor embedded banks, decoupled authorisation was initiated by the bankPENDING
EMBEDDED_CREDENTIAL_REQUESTEDFor embedded banks, a UI element to collect user credentials was displayedPENDING
EMBEDDED_CODE_REQUESTEDFor embedded banks, a UI element to collect SCA for initiated consent was displayedPENDING
EMBEDDED_TYPE_REQUESTEDFor embedded banks, a UI element to allow the user to select their preferred SCA method for this consent authorisation was displayedPENDING
EMBEDDED_CODE_COLLECTEDFor embedded banks, SCA code was collected for consent authorisationPENDING
EMBEDDED_TYPE_SELECTEDFor embedded banks, preferred SCA method was selected for consent authorisationPENDING
CONSENT_POLLING_STARTEDPolling the bank for consent authorisation status startedPENDING
CONSENT_POLLING_ENDEDPolling the bank for consent authorisation status finishedPENDING
AUTHORISEDConsent authorisation completedAUTHORIZED
REVOKEDConsent has been revoked and is no longer activeREVOKED
FINISHEDFlow finishedAUTHORIZED/PENDING/FAILED

​
Hosted Pages Resources

​
API Resources

​
Implementation Resources