Pular para o conteúdo

Get data consent

Returns the Open Finance data consent created by the Linked journey (Smart Pix). This is an authenticated proxy to Data Link: the service calls it with its own IAM credentials, so you only need your bearer token.

Use the dataConsentId returned by Create optimized automatic payment as the path consentId. Poll until data.status is AUTHORISED, then read data.userId — it is the input of Get user accounts.

GET/api/v1/linked-journey/consents/{consentId}

Get data consent by id

Retrieves the Data Link data consent, including its status and the userId used to list accounts.

Auth: Bearer Token

Path parameters

1 campo
consentId●
pathstring

Data Link consent id — the `dataConsentId` from the 201. URN encoded in the URL by the client.

Headers

2 campos
X-Client-IP●
headerstring

IP address of the end user.

subTenantId
headerstring

Optional; kept for consistency with the other routes of the journey. It is not forwarded to Data Link on this GET.

curl --request GET \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/linked-journey/consents/urn%3Araidiambank%3Aconsent%3A77535481-63b5-4e28-becb-0349158f9e35' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --header 'X-Client-IP: 200.150.100.50' \
  --header 'subTenantId: 1f2b6a1c-6a3e-4b1a-9f0e-6f0b1a2c3d4e'

Response

200Data consent returned successfully.
Response body
object
  • dataobjectrequired

    Data consent as returned by Data Link.

    • userIdstring

      User id at Data Link — input of Get user accounts.

    • consentIdstring

      Consent URN.

    • creationDateTimestring· date-time

      When the consent was created.

    • statusstring

      Consent status: `AWAITING_AUTHORISATION`, `AUTHORISED`, `REJECTED`, among others.

    • statusUpdateDateTimestring· date-time

      Last status change.

    • permissionsarray of string

      Fixed permission set defined by the service when the consent was created.

    • organisationIdstring

      Organisation id.

    • organisationNamestring

      Organisation name.

    • authorisationServerIdstring

      Authorisation server id.

    • versionnumber

      Consent version at Data Link.

    • createdAtstring· date-time

      Record creation.

    • updatedAtstring· date-time

      Record update.

    • tenantIdstring

      Tenant that owns the consent.

    • expirationDateTimestring· nullable· date-time

      Consent expiry when defined.

    • redirectUrlstring· nullable

      Redirect URL stored with the consent when applicable.

    • callbackValidatedboolean

      Whether the callback was validated.

    • clientIdstring

      Client that created the consent.

    • authorizedAtstring· date-time

      When the payer authorised the consent.

    • rejectedAtstring· nullable· date-time

      When the consent was rejected, if it was.

  • messagestring

    Response message.

  • typestring

    Envelope type (for example `success`).

  • statusCodeinteger· nullable

    HTTP status code.

200 · Data consent returned successfully.
{
  "type": "success",
  "message": "Data consent retrieved successfully",
  "data": {
    "userId": "283f1e2e-0d99-46e9-a4a6-91e41add490c",
    "consentId": "urn:raidiambank:consent:77535481-63b5-4e28-becb-0349158f9e35",
    "creationDateTime": "2026-05-14T18:38:03Z",
    "status": "AUTHORISED",
    "statusUpdateDateTime": "2026-05-14T18:38:45.753Z",
    "permissions": [
      "RESOURCES_READ",
      "ACCOUNTS_BALANCES_READ",
      "ACCOUNTS_OVERDRAFT_LIMITS_READ",
      "ACCOUNTS_READ"
    ],
    "organisationId": "74e929d9-33b6-4d85-8ba7-c146c867a817",
    "organisationName": "Open Banking Brasil",
    "authorisationServerId": "c8f0bf49-4744-4933-8960-7add6e590841",
    "version": 3,
    "createdAt": "2026-05-14T18:38:04.552Z",
    "updatedAt": "2026-05-14T18:38:04.552Z",
    "tenantId": "lina",
    "expirationDateTime": null,
    "redirectUrl": null,
    "callbackValidated": false,
    "clientId": "lina-pay",
    "authorizedAt": "2026-05-14T18:38:45.753Z",
    "rejectedAt": null
  }
}

Next steps