Skip to main content
GET
/
api
/
v1
/
recipients
/
{client_id}
/
providers
/
requests
Get the Registration Status for a Data Recipient
curl --request GET \
  --url https://ob.flinksapp.com/api/v1/recipients/{client_id}/providers/requests \
  --header 'Authorization: Bearer <token>'
[
  {
    "client_id": "dc-xxxxxxxxxxxxxxxxxxxxxxxxx",
    "client_name": "Flinks Fake",
    "provider_id": 1000,
    "provider_name": "Flinks Capital",
    "country": "CA",
    "registration_status": "PENDING_APPROVAL",
    "requested_on": "2024-02-29T14:24:42.6009460Z"
  },
  {
    "client_id": "dc-xxxxxxxxxxxxxxxxxxxxxxxxx",
    "client_name": "Flinks Fake",
    "provider_id": 2000,
    "provider_name": "NBC",
    "country": "CA",
    "registration_status": "PENDING_APPROVAL",
    "requested_on": "2024-02-29T14:24:42.6055680Z"
  }
]
Use the /api/v1/recipients/{client_id}/providers/requests endpoint to check the registrations status of a Data Recipient. 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
The following is a list of possible registration statuses:
STATUSDESCRIPTION
PENDING_APPROVALA partner has sent a registration request and is awaiting approval from Flinks.
PENDING_ACTIVATIONFlinks has approved the registration request and it’s been sent to the Data Provider for activation.
ACTIVEThe Data Provider is registered with the Data Recipient. The Data Recipient can successfully use the Flinks Open Banking API for this particular Data Provider.

Authorizations

​
Authorization
string
header
required

Bearer token obtained from the /Token endpoint.

Path Parameters

​
client_id
string
required

The ID of Data Recipient who you want to check the registrations status for.

Response

Result

​
client_id
string

Unique identifier for the data recipient.

​
client_name
string

Name of the data recipient.

​
provider_id
integer

Unique identifier for the data provider.

​
provider_name
string

Name of the data provider.

​
country
string

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

​
registration_status
string

Current registration status (PENDING_APPROVAL, PENDING_ACTIVATION, or ACTIVE).

​
requested_on
string

Timestamp of when the registration was requested (ISO 8601 format).