Skip to main content
GET
Get Data Recipient Details
Use the /api/v1/recipients/{client_id} endpoint to get additional details for a particular Data Recipient, including the scopes and redirect URLs. To successfully call this endpoint, you must first call the /Token endpoint to obtain a valid access_token using the following settings:
  • grant_type: client_credentials
  • client_id: {partner client_id}
  • client_secret: {partner client_secret}
  • scope: client:admin

Authorizations

Authorization
string
header
required

Bearer token obtained from the /Token endpoint.

Path Parameters

client_id
string
required

The id for the Data Recipient you want to retrieve details for.

Response

Result

scope
string

Space-separated list of scopes the data recipient has access to (e.g., ACCOUNT_BASIC ACCOUNT_DETAILED TRANSACTIONS STATEMENTS).

redirect_uris
string[]

List of authorized redirect URIs for the data recipient.

client_id
string

Unique identifier for the data recipient.

name
string

Name of the data recipient.

logo_uri
string

URL to the data recipient's logo.

description
string

Description of the data recipient.

terms_uri
string

URL to the data recipient's terms of service.

client_uri
string

URL to the data recipient's website.

country
string

Country code of the data recipient (e.g., CA, US).

contacts
object[]

Contact information for the data recipient.