Create Consent (IMPLICIT)

This endpoint starts the process of creating a Consent.

The Consent is created in an INITIATED state.

A One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD SCA_METHOD is typically "SMS","EMAIL" or "IMPLICIT". "EMAIL" is used for testing purposes. OBP mapped mode "IMPLICIT" is "EMAIL". Other mode, bank can decide it in the connector method 'getConsentImplicitSCA'.

When the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.

An OBP Consent allows the holder of the Consent to call one or more endpoints.

Consents must be created and authorisied using SCA (Strong Customer Authentication).

That is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.

Each Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.

Each Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.

Examples:

For example: GET /obp/v4.0.0/users/current HTTP/1.1 Host: 127.0.0.1:8080 Consent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn 1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj EtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml zcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY tNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg

Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk cache-control: no-cache

Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 7776000 seconds (90 days).

Example of POST JSON: { "everything": false, "views": [ { "bank_id": "GENODEM1GLS", "account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "view_id": "owner" } ], "entitlements": [ { "bank_id": "GENODEM1GLS", "role_name": "CanGetCustomersAtOneBank" } ], "consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "email": "eveline@example.com", "valid_from": "2020-02-07T08:43:34Z", "time_to_live": 3600 } Please note that only optional fields are: consumer_id, valid_from and time_to_live. In case you omit they the default values are used: consumer_id = the Consumer making this call valid_from = current time time_to_live = consents.max_time_to_live

Every Consent is pinned to one Consumer, and only that Consumer can present the resulting Consent JWT -- any other gets ConsentNotFound. Set consumer_id when the Consent is for a different application than the caller, for example a portal creating a Consent for an agent to use. Omit it when the Consent is for the caller. A Consent that names no Consumer is refused.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Example 1: { "everything": true, "views": [], "entitlements": [], "consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", }

Please note that consumer_id is an optional field. It names the Consumer the Consent is for -- set it when the Consent is for a different application than the caller (for example a portal creating a Consent for an agent to use), omit it when the Consent is for the caller. Either way the resulting Consent is pinned to exactly one Consumer, and only that Consumer can present it. Example 2: { "everything": true, "views": [], "entitlements": [], }

Please note if everything=false you need to explicitly specify views and entitlements Example 3: { "everything": false, "views": [ { "bank_id": "GENODEM1GLS", "account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "view_id": "owner" } ], "entitlements": [ { "bank_id": "GENODEM1GLS", "role_name": "CanGetCustomersAtOneBank" } ], "consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", }

URL Parameters:

IMPLICIT: IMPLICIT