Clients | Rialto API

Returns the list of clients.

get

The clients are sorted by creation date, in descending order. The most recently created clients appear first. The clients are paginated, a maximum of 10 clients are returned per page. If there are more clients to fetch, the response includes a non null nextPageCursor field. The nextPageCursor can be injected in the cursor parameter to fetch the next page of clients. If the nextPageToken field is null, there are no more clients to fetch.

Authorizations

Query parameters

cursorstring · date-timeoptional

The cursor to fetch the next page of clients.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.rialtobridge.xyz/api/manager/v1/clients' \
  --header 'RIALTO_API_KEY: YOUR_API_KEY'

200

400

401

500

{
  "items": [
    {
      "id": "9c0306d5-e18e-4689-93da-997e2cdc16e7",
      "status": "VERIFIED",
      "clientType": "INDIVIDUAL",
      "individualProfile": {
        "firstName": "Jack",
        "lastName": "Dowie",
        "email": "jack.dowie@def.com",
        "phone": "+33 1 23 45 67 89",
        "address": "1, rue de la Paix",
        "city": "Paris",
        "postalCode": "75002",
        "countryCode": "FR",
        "occupation": "entrepreneur",
        "occupationDescription": null,
        "companyName": "DEF",
        "jobBusinessSector": "agriculture",
        "jobBusinessSectorDescription": null,
        "purposeOfOnboarding": "treasuryManagement"
      },
      "individualSourceOfFunds": {
        "sourceOfFunds": "salary",
        "sourceOfFundsDescription": null,
        "annualRevenueRange": "50kTo80k",
        "globalWealthRange": "100kTo200k",
        "sourceOfFundsDocuments": [
          "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file1.pdf"
        ],
        "proofOfTaxResidencyDocuments": [
          "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/5989c311-33e4-4553-912b-245716fb87a4_file2.pdf"
        ],
        "taxNoticeDocuments": [
          "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/adf069db-85d5-4c8e-9652-559754eaf5e2_file3.pdf"
        ],
        "supportingOccupationDocuments": [
          "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/707aa599-9cf3-42f6-91b1-cca2a4fe75d3_file4.pdf"
        ]
      },
      "company": null,
      "companyRepresentatives": null,
      "onboardingResubmissionReason": null,
      "createdAt": "2024-12-03T10:07:54.940Z",
      "updatedAt": "2024-12-03T10:07:54.940Z",
      "deletedAt": null
    },
    {
      "id": "e5b47b67-7ef9-45c3-abd3-79eac5551cc4",
      "status": "VERIFIED",
      "clientType": "ENTITY",
      "individualProfile": null,
      "individualSourceOfFunds": null,
      "company": {
        "name": "ABC",
        "registrationNumber": "123456789",
        "registeredAddress": "1, rue de la Paix",
        "registeredAddressCity": "Paris",
        "registeredAddressPostalCode": "75002",
        "registeredAddressCountryCode": "FR",
        "placeOfEffectiveBusiness": "1, rue de la Paix",
        "businessSector": "agriculture",
        "businessSectorDescription": null,
        "turnover": "140",
        "turnoverDocuments": [
          "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426393_file_10.pdf"
        ],
        "lastTaxNoticeDocuments": [
          "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/c30bf422-1154-430f-8825-fa06a4ec3387_file_11.pdf"
        ],
        "purposeOfOnboarding": "treasuryManagement"
      },
      "companyRepresentatives": [
        {
          "id": "667fee7e-a467-495a-8084-b476eee9aba2",
          "firstName": "John",
          "lastName": "Doe",
          "email": "john.doe@abc.com",
          "phone": "+33 1 23 45 67 89",
          "jobTitle": "CEO",
          "supportingDocuments": [
            "66d083a7-a196-49f8-a41f-2a52bafa5a41_file23.pdf"
          ],
          "role": "AUTHORIZED_SIGNATORY",
          "createdAt": "2024-12-25T12:30:00.940Z"
        },
        {
          "id": "37398962-9408-4027-989b-22f2ddb6de20",
          "firstName": "Jane",
          "lastName": "Doe",
          "email": "jane.doe@abc.com",
          "phone": "+33 1 87 32 99",
          "jobTitle": "CFO",
          "supportingDocuments": [],
          "role": "OPERATOR",
          "createdAt": "2024-12-25T12:45:00.940Z"
        }
      ],
      "onboardingResubmissionReason": null,
      "createdAt": "2024-12-03T10:07:54.940Z",
      "updatedAt": "2024-12-03T10:07:54.940Z",
      "deletedAt": null
    }
  ],
  "nextPageCursor": "mull"
}

A JSON array of clients.

Returns a client by ID.

get

Returns a client by its unique identifier.

Authorizations

Path parameters

clientIdstring · uuidrequired

The unique identifier of the client.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.rialtobridge.xyz/api/manager/v1/clients/{clientId}' \
  --header 'RIALTO_API_KEY: YOUR_API_KEY'

200

401

404

500

{
  "id": "9c0306d5-e18e-4689-93da-997e2cdc16e7",
  "status": "VERIFIED",
  "clientType": "INDIVIDUAL",
  "individualProfile": {
    "firstName": "Jack",
    "lastName": "Dowie",
    "email": "jack.dowie@def.com",
    "phone": "+33 1 23 45 67 89",
    "address": "1, rue de la Paix",
    "city": "Paris",
    "postalCode": "75002",
    "countryCode": "FR",
    "occupation": "entrepreneur",
    "occupationDescription": null,
    "companyName": "DEF",
    "jobBusinessSector": "agriculture",
    "jobBusinessSectorDescription": null,
    "purposeOfOnboarding": "treasuryManagement"
  },
  "individualSourceOfFunds": {
    "sourceOfFunds": "salary",
    "sourceOfFundsDescription": null,
    "annualRevenueRange": "50kTo80k",
    "globalWealthRange": "100kTo200k",
    "sourceOfFundsDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file1.pdf"
    ],
    "proofOfTaxResidencyDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/5989c311-33e4-4553-912b-245716fb87a4_file2.pdf"
    ],
    "taxNoticeDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/adf069db-85d5-4c8e-9652-559754eaf5e2_file3.pdf"
    ],
    "supportingOccupationDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/707aa599-9cf3-42f6-91b1-cca2a4fe75d3_file4.pdf"
    ]
  },
  "company": null,
  "companyRepresentatives": null,
  "onboardingResubmissionReason": null,
  "createdAt": "2024-12-03T10:07:54.940Z",
  "updatedAt": "2024-12-03T10:07:54.940Z",
  "deletedAt": null
}

A client.

Deletes a client by ID.

delete

Deletes a client by its unique identifier. A deleted client cannot be recovered. It is still queryable but its status is set to DELETED. It is not possible to create transactions with a deleted client.

Authorizations

Path parameters

clientIdstring · uuidrequired

The unique identifier of the client.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.rialtobridge.xyz/api/manager/v1/clients/{clientId}' \
  --header 'RIALTO_API_KEY: YOUR_API_KEY'

200

401

404

500

{
  "id": "9c0306d5-e18e-4689-93da-997e2cdc16e7",
  "status": "VERIFIED",
  "clientType": "INDIVIDUAL",
  "individualProfile": {
    "firstName": "Jack",
    "lastName": "Dowie",
    "email": "jack.dowie@def.com",
    "phone": "+33 1 23 45 67 89",
    "address": "1, rue de la Paix",
    "city": "Paris",
    "postalCode": "75002",
    "countryCode": "FR",
    "occupation": "entrepreneur",
    "occupationDescription": null,
    "companyName": "DEF",
    "jobBusinessSector": "agriculture",
    "jobBusinessSectorDescription": null,
    "purposeOfOnboarding": "treasuryManagement"
  },
  "individualSourceOfFunds": {
    "sourceOfFunds": "salary",
    "sourceOfFundsDescription": null,
    "annualRevenueRange": "50kTo80k",
    "globalWealthRange": "100kTo200k",
    "sourceOfFundsDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file1.pdf"
    ],
    "proofOfTaxResidencyDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/5989c311-33e4-4553-912b-245716fb87a4_file2.pdf"
    ],
    "taxNoticeDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/adf069db-85d5-4c8e-9652-559754eaf5e2_file3.pdf"
    ],
    "supportingOccupationDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/707aa599-9cf3-42f6-91b1-cca2a4fe75d3_file4.pdf"
    ]
  },
  "company": null,
  "companyRepresentatives": null,
  "onboardingResubmissionReason": null,
  "createdAt": "2024-12-03T10:07:54.940Z",
  "updatedAt": "2024-12-03T12:09:00.120Z",
  "deletedAt": "2024-12-03T12:09:00.120Z"
}

Client deleted.