Partners

Get Partner Information

To access partner data crucial for facilitating further API interactions, initiate a GET request to the following endpoint:

https://cubi-sandbox-api.customersbank.com/partners/v1/

This endpoint provides partner details including ID, Name, and the API products enabled by the partner.

Example Request:

GET /partners/v1/ HTTP/1.1
Host: cubi-sandbox-api.customersbank.com
Authorization: Bearer ******

A successful request will generate a response of 200 – Success.

Example Response:

{
    "id": "111111-b26d-46d2-bdd7-629f956dd966",
    "name": "Test Client",
    "isFrozen": false,
    "apiProducts": [
        {
            "id": "11111111-6418-4ae5-be62-aa2e3488a2a4",
            "name": "Test Bank",
            "isEnabled": false
        },
        {
            "id": "11111111-d7d5-4e29-b57e-915ae19fcf38",
            "name": "Test Partner",
            "isEnabled": true
        }
    ]
}

Response Data Element Details

Name	Type	Description
id	string	customer id
name	string \| null	customer name
isFrozen	boolean	indicates if the customer profile is frozen
API Products	an array of objects	API Products model
> id	string	API id
> name	string \| null	API name
> isEnabled	boolean	indicates if the API is enabled

Error Handling
Common errors will include:
400 – Bad Request
401 – Unauthorized
403 – Forbidden
404 – Not Found

For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.

List Client Secrets

Client Secrets serve as credentials explicitly managed by the administrator on behalf of the partner. Access to endpoints associated with managing credentials are restricted solely to administrators.

To access the API credentials assigned to the partner, administrators can initiate a GET request directed to the following endpoint:

https://cubi-sandbox-api.customersbank.com/partners/v1/credentials

This endpoint displays the API credentials that have been created for the partner.

Example Request:

GET /partners/v1/credentials HTTP/1.1
Host: cubi-sandbox-api.customersbank.com
Authorization: Bearer ******

A successful request will generate a response of 200 – Success.

Example Response:

[
    {
        "keyId": "11111111-feba-4ecf-a1a7-a3113628ebe4",
        "displayName": "API 1",
        "startDateTime": "2024-04-22T18:05:23.7290172+00:00",
        "endDateTime": "2026-04-22T18:05:23.7290172+00:00",
        "hint": "Aa1"
    },
    {
        "keyId": "11111111-71b7-41ce-83af-9e71b926b620",
        "displayName": "API 2",
        "startDateTime": "2024-04-18T20:31:35.5444529+00:00",
        "endDateTime": "2026-04-18T20:31:35.5444529+00:00",
        "hint": "bC2"
    }
]

Response Data Element Details:

Name	Type	Description
keyId	string	client secret ID
displayName	string \| null	client secret name
startDateTime	date-time	Optional: date and time client secret becomes available
endDateTime	date-time	Optional: date and time client secret is no longer available
hint	string \| null
secretText	string \| null

Error Handling:
Common errors will include:
400 – Bad Request
401 – Unauthorized
403 – Forbidden
404 – Not Found
422 – Unprocessable Content

For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.

Create Secret

Partners have the option to create up to two client secrets that are valid for up to six months. The initial client secret is generated within the user interface portal. Subsequently, partners can generate a second secret by initiating a POST request directed to the following endpoint:

https://cubi-sandbox-api.customersbank.com/partners/v1/credentials

This request requires the additional data to be included in the body of the request.

Body Parameter Data Element Details:

Name	Type	Description
displayName	string \| null	client secret name
startDateTime	date-time	Optional: date and time client secret becomes available
endDateTime	date-time	Optional: date and time client secret is no longer available

Example Request:

POST /partners/v1/credentials HTTP/1.1
Host: cubi-sandbox-api.customersbank.com
Content-Type: application/json
Authorization: Bearer ******
Content-Length: 94

{
    "displayName": "Doc Test 2",
    "endDateTime": "2025-04-22T18:05:23.7290172+00:00"
}

A successful request will generate a response of 200 – Success

Example Response:

{
    "keyId": "11111111-d828-4568-aa98-78f543b4a84b",
    "displayName": "Doc Test 2",
    "startDateTime": "2024-05-31T17:12:21.9923852+00:00",
    "endDateTime": "2025-04-22T18:05:23.7290172+00:00",
    "hint": "OOU",
    "secretText": "12345~6~11111111111111111111111111111111"
}

Response Data Element Details:

Name	Type	Description
keyId	string	client secret ID
displayName	string \| null	client secret name
startDateTime	date-time	Optional: date and time client secret becomes available
endDateTime	date-time	Optional: date and time client secret is no longer available
hint	string \| null
secretText	string \| null

Error Handling
Common Errors will include:
400 – Bad Request
401 – Unauthorized
403 – Forbidden
422 – Unprocessable Content

For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.

Delete Credentials

Administrators have the capability to delete their credentials by initiating a DELETE request directed to the following endpoint:

https://cubi-sandbox-api.customersbank.com/partners/v1/credentials/{id}

This request requires the additional data to be included in the path of the request

Path Parameter Data Element Details:

Name	Type	Description
id	string	client secret id

Example Request:

DELETE /partners/v1/credentials/11111111-d828-4568-aa98-78f543b4a84b HTTP/1.1
Host: cubi-sandbox-api.customersbank.com
Authorization: Bearer ••••••

A successful request will generate a response of 204 - No Content.

Error Handling:
Common errors will include:
400 – Bad Request
401 – Unauthorized
403 – Forbidden
422 – Unprocessable Content

For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.