API Reference
Client PortalAPI StatusWebsite

List profiles owned by the caller.

get
https://www.bankingcircleconnect.com/api/v1/digital-assets/profiles
Query Params
companyNumbers
array of strings

Company numbers used to scope profile queries. Omit (or pass an empty list) to use every company the caller has access to.

companyNumbers
int32 | int32
1 to 5000
^-?(?:0|[1-9]\d*)$

Max number of records to return on the initial page. Must be bigger than 0 and less than or equal to 5000. Default is 100. Cannot be used together with cursor.

enum

Order of records on the initial page. Cannot be used together with cursor.

Allowed:
string
length between 1 and 512
^[A-Za-z0-9_=\-]+$

Cursor from a previous response used to fetch the next or previous page. Cannot be used with any other parameters except direction.

enum

Traversal direction when using cursor. Required when using cursor.

Allowed:
statuses
array of objects

Filter profiles by lifecycle status. Omit to include all statuses.

statuses
Allowed:
date-time

Inclusive lower bound on profile creation time (RFC 3339).

date-time

Inclusive upper bound on profile creation time (RFC 3339).

Responses

Updated 2 days ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago

Did this page help you?