YAyapily
Consents

Exchange OAuth2 Code

Used to obtain a Yapily Consent object containing the consentToken once the user has authenticated and you have an OAuth2 authorisation code auth-code and state auth-state.

post/consent-auth-code

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Request body

authCodestring required

Mandatory. The authorisation code

authStatestring required

Mandatory. The authorisation state

Example request

{
  "authCode": "6b965fbb-ff09-4afa-b897-90c34797cb8f",
  "authState": "1270cb2ffc4842b78953afa2228e0a87"
}

Response

Ok

idstring uuid

Unique identifier of the consent.

userUuidstring uuid
applicationUserIdstring

Conditional. The user-friendly reference to the User that will authorise the authorisation request. If a User with the specified applicationUserId exists, it will be used otherwise, a new User with the specified applicationUserId will be created and used. Either the userUuid or applicationUserId must be provided.

referenceIdstring
institutionIdstring

Mandatory. The Institution the authorisation request is sent to.

status'AWAITING_AUTHORIZATION' | 'AWAITING_FURTHER_AUTHORIZATION' | 'AWAITING_RE_AUTHORIZATION' | 'AUTHORIZED' | 'CONSUMED' | 'REJECTED' | 'REVOKED' | 'FAILED' | 'EXPIRED' | 'UNKNOWN' | 'INVALID' | 'AWAITING_DECOUPLED_PRE_AUTHORIZATION' | 'AWAITING_PRE_AUTHORIZATION' | 'PRE_AUTHORIZED' | 'AWAITING_DECOUPLED_AUTHORIZATION' | 'AWAITING_SCA_METHOD' | 'AWAITING_SCA_CODE'

Current status of the embedded authorisation request in code form.

createdAtstring date-time

Date and time of when the consent was created.

transactionFromstring date-time

When performing a transaction query using the consent, this is the earliest date of transaction records that can be retrieved.

transactionTostring date-time

When performing a transaction query using the consent, this is the latest date of transaction records that can be retrieved.

expiresAtstring date-time

Date and time of when the authorisation will expire by. Reauthorisation will be needed to retain access.

timeToExpireInMillisinteger
timeToExpirestring iso8601
featureScopeFeatureEnum[]

The set of features that the consent will provide access to.

consentTokenstring

Represents the authorisation to gain access to the requested features. Required to access account information or make a payment request.

statestring

Correlation ID used with the Institution during the authorisation process.

authorizedAtstring date-time

Date and time of when the request was authorised by the Institution.

lastConfirmedAtstring date-time

The time that the PSU last confirmed access to their account information, either through full authentication with the institution, or through reconfirmation with the TPP.

reconfirmBystring date-time

The time by which the consent should be reconfirmed to ensure continued access to the account information.

institutionConsentIdstring

Identification of the consent at the Institution.

isDeletedByInstitutionboolean

Denotes whether the consent has been deleted on the institution side or not when a DELETE method is executed on a Yapily consent if that functionality is provided by the institution

Changes

No recorded changes to this operation across all 4 revisions of this API.