Hosted Data Consent Statuses and Phases

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 Name	Phase Description	Status
INITIATED	Process initiated	PENDING
INSTITUTION_SUBMITTED	Consent institution submitted	PENDING
AUTHORISATION_INITIATED	All details required for consent initiation have been collected	PENDING
AUTHORISATION_CREATED	Consent authorisation request created with Institution, awaiting authorisation completion	PENDING
AUTHORISATION_FAILED	Consent authorisation failed and will not proceed further	FAILED
AUTHORISATION_REJECTED	Consent Authorisation request rejected by Institution and will not proceed further	FAILED
DECOUPLED_AUTHORISATION	For embedded banks, decoupled authorisation was initiated by the bank	PENDING
EMBEDDED_CREDENTIAL_REQUESTED	For embedded banks, a UI element to collect user credentials was displayed	PENDING
EMBEDDED_CODE_REQUESTED	For embedded banks, a UI element to collect SCA for initiated consent was displayed	PENDING
EMBEDDED_TYPE_REQUESTED	For embedded banks, a UI element to allow the user to select their preferred SCA method for this consent authorisation was displayed	PENDING
EMBEDDED_CODE_COLLECTED	For embedded banks, SCA code was collected for consent authorisation	PENDING
EMBEDDED_TYPE_SELECTED	For embedded banks, preferred SCA method was selected for consent authorisation	PENDING
CONSENT_POLLING_STARTED	Polling the bank for consent authorisation status started	PENDING
CONSENT_POLLING_ENDED	Polling the bank for consent authorisation status finished	PENDING
AUTHORISED	Consent authorisation completed	AUTHORIZED
REVOKED	Consent has been revoked and is no longer active	REVOKED
FINISHED	Flow finished	AUTHORIZED/PENDING/FAILED

Hosted Pages Resources

Data Tutorial - Complete data access integration guide
UI Screens - Visual guide to the hosted flow

API Resources

GET /hosted/consent-requests - Retrieve consent request details
Consent Management - Managing data consents

Implementation Resources

Error Handling - Handle consent failures gracefully
Support - Get help with implementation

Learn

Build

Payments

Data

Hosted Pages

Resources

Introduction

Mapping Between Status and Phases

Hosted Pages Resources

API Resources

Implementation Resources

​Introduction

​Related Fields in Response

​Mapping Between Status and Phases

​Related Resources

​Hosted Pages Resources

​API Resources

​Implementation Resources

Introduction

Related Fields in Response

Mapping Between Status and Phases

Related Resources

Hosted Pages Resources

API Resources

Implementation Resources