Clients

Returns the list of clients.

get

https://api.rialtobridge.xyz/api/manager/v1https://staging.api.rialtobridge.xyz/api/manager/v1http://localhost:3002/api/manager/v1

/clients

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

api_key

RIALTO_API_KEYstringRequired

Query parameters

cursorstring · date-timeOptional

The cursor to fetch the next page of clients.

Responses

200

A JSON array of clients.

application/json

nextPageCursorstring · nullableOptional

400

The request is invalid.

application/json

401

Invalid API key

500

An unexpected error occurred.

get

/clients

HTTPcURLJavaScriptPython

GET /api/manager/v1/clients HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": "9c0306d5-e18e-4689-93da-997e2cdc16e7",
      "status": "VERIFIED",
      "clientType": "INDIVIDUAL",
      "individualProfile": {
        "firstName": "Jack",
        "lastName": "Dowie",
        "email": "[email protected]",
        "phone": "[phone]",
        "address": "1, rue de la Paix",
        "city": "Paris",
        "postalCode": "75002",
        "countryCode": "FR",
        "occupation": "entrepreneur",
        "occupationDescription": null,
        "companyName": "DEF",
        "jobBusinessSector": "agriculture",
        "jobBusinessSectorDescription": null,
        "purposeOfOnboarding": "treasuryManagement",
        "idDocuments": [
          "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file1.pdf"
        ],
        "proofOfAddressDocuments": [
          "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file2.pdf"
        ],
        "proofOfAmlDocuments": [
          "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file3.pdf"
        ]
      },
      "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,
      "companyDirectorsAndUbos": 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",
        "proofOfIncorporationDocuments": [
          "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426394_file12.pdf"
        ],
        "memorandumOfAssociationDocuments": [
          "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426395_file13.pdf"
        ],
        "registryOfDirectorsAndShareholdersDocuments": [
          "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426396_file14.pdf"
        ],
        "structureChartOfShareholdersDocuments": [
          "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426397_file15.pdf"
        ],
        "proofOfAmlDocuments": [
          "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426398_file16.pdf"
        ]
      },
      "companyRepresentatives": [
        {
          "id": "667fee7e-a467-495a-8084-b476eee9aba2",
          "firstName": "John",
          "lastName": "Doe",
          "email": "[email protected]",
          "phone": "[phone]",
          "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": "[email protected]",
          "phone": "[phone]",
          "jobTitle": "CFO",
          "supportingDocuments": [],
          "role": "OPERATOR",
          "createdAt": "2024-12-25T12:45:00.940Z"
        }
      ],
      "companyDirectorsAndUbos": {
        "directors": [
          {
            "id": "667fee7e-a467-495a-8084-b476eee9aba2",
            "name": "John Doe",
            "idDocuments": [
              "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426393_file_10.pdf"
            ],
            "proofOfAddressDocuments": [
              "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426393_file_10.pdf"
            ],
            "proofOfAmlDocuments": [
              "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426393_file_10.pdf"
            ],
            "createdAt": "2024-12-25T12:45:00.940Z"
          }
        ],
        "ubos": [
          {
            "id": "667fee7e-a467-495a-8084-b476eee9aba2",
            "typeOfPerson": "NATURAL",
            "name": "Jane Doe",
            "idDocuments": [
              "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426393_file_10.pdf"
            ],
            "proofOfAddressDocuments": [
              "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426393_file_10.pdf"
            ],
            "proofOfAmlDocuments": [
              "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426393_file_10.pdf"
            ],
            "createdAt": "2024-12-25T12:45:00.940Z"
          },
          {
            "id": "667fee7e-a467-495a-8084-b476eee9aba2",
            "typeOfPerson": "Legal",
            "name": "Jane Doe Limited",
            "proofOfIncorporationDocuments": [
              "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426393_file_10.pdf"
            ],
            "memorandumOfAssociationDocuments": [
              "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426393_file_10.pdf"
            ],
            "registryOfDirectorsAndShareholdersDocuments": [
              "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426393_file_10.pdf"
            ],
            "proofOfAmlDocuments": [
              "rialto-clients/entities/e5b47b67-7ef9-45c3-abd3-79eac5551cc4/52b01849-c96d-4808-9c96-b1e207426393_file_10.pdf"
            ],
            "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"
}

Returns a client by ID.

get

https://api.rialtobridge.xyz/api/manager/v1https://staging.api.rialtobridge.xyz/api/manager/v1http://localhost:3002/api/manager/v1

/clients/{clientId}

Returns a client by its unique identifier.

Authorizations

api_key

RIALTO_API_KEYstringRequired

Path parameters

clientIdstring · uuidRequired

The unique identifier of the client.

Responses

200

A client.

application/json

idstring · uuidOptional

The unique identifier of the client.

statusstring · enumOptional

The status of the client.

• ONBOARDING_IN_PROGRESS: The client is in the onboarding process.
• ONBOARDING_UNDER_REVIEW: The client is under review.
• RESUBMISSION_REQUIRED: Rialto's compliance team has required more information for onboarding, information must be resubmitted.
• WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE: The client is waiting for the terms and conditions signature.
• VERIFIED: The client is verified,
• DELETED: The client is deleted.

Possible values:

clientTypestring · enumOptional

The type of the client.

• INDIVIDUAL: The client is an individual client.
• ENTITY: The client is an entity client.

Possible values:

onboardingResubmissionReasonstring · nullableOptional

The reason why the onboarding information must be resubmitted. This field is only present when the client is in the status RESUBMISSION_REQUIRED.

createdAtstring · date-timeOptional

The creation date of the client.

updatedAtstring · date-timeOptional

The last update date of the client.

deletedAtstring · nullableOptional

The deletion date of the client.

401

Invalid API key

404

Client not found.

500

An unexpected error occurred.

get

/clients/{clientId}

HTTPcURLJavaScriptPython

GET /api/manager/v1/clients/{clientId} HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

{
  "id": "9c0306d5-e18e-4689-93da-997e2cdc16e7",
  "status": "VERIFIED",
  "clientType": "INDIVIDUAL",
  "individualProfile": {
    "firstName": "Jack",
    "lastName": "Dowie",
    "email": "[email protected]",
    "phone": "[phone]",
    "address": "1, rue de la Paix",
    "city": "Paris",
    "postalCode": "75002",
    "countryCode": "FR",
    "occupation": "entrepreneur",
    "occupationDescription": null,
    "companyName": "DEF",
    "jobBusinessSector": "agriculture",
    "jobBusinessSectorDescription": null,
    "purposeOfOnboarding": "treasuryManagement",
    "idDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file1.pdf"
    ],
    "proofOfAddressDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file2.pdf"
    ],
    "proofOfAmlDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file3.pdf"
    ]
  },
  "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,
  "companyDirectorsAndUbos": null,
  "onboardingResubmissionReason": null,
  "createdAt": "2024-12-03T10:07:54.940Z",
  "updatedAt": "2024-12-03T10:07:54.940Z",
  "deletedAt": null
}

Deletes a client by ID.

delete

https://api.rialtobridge.xyz/api/manager/v1https://staging.api.rialtobridge.xyz/api/manager/v1http://localhost:3002/api/manager/v1

/clients/{clientId}

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

api_key

RIALTO_API_KEYstringRequired

Path parameters

clientIdstring · uuidRequired

The unique identifier of the client.

Responses

200

Client deleted.

application/json

idstring · uuidOptional

The unique identifier of the client.

statusstring · enumOptional

The status of the client.

• ONBOARDING_IN_PROGRESS: The client is in the onboarding process.
• ONBOARDING_UNDER_REVIEW: The client is under review.
• RESUBMISSION_REQUIRED: Rialto's compliance team has required more information for onboarding, information must be resubmitted.
• WAITING_FOR_TERMS_AND_CONDITIONS_SIGNATURE: The client is waiting for the terms and conditions signature.
• VERIFIED: The client is verified,
• DELETED: The client is deleted.

Possible values:

clientTypestring · enumOptional

The type of the client.

• INDIVIDUAL: The client is an individual client.
• ENTITY: The client is an entity client.

Possible values:

onboardingResubmissionReasonstring · nullableOptional

The reason why the onboarding information must be resubmitted. This field is only present when the client is in the status RESUBMISSION_REQUIRED.

createdAtstring · date-timeOptional

The creation date of the client.

updatedAtstring · date-timeOptional

The last update date of the client.

deletedAtstring · nullableOptional

The deletion date of the client.

401

Invalid API key

404

Client not found.

500

An unexpected error occurred.

delete

/clients/{clientId}

HTTPcURLJavaScriptPython

DELETE /api/manager/v1/clients/{clientId} HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

{
  "id": "9c0306d5-e18e-4689-93da-997e2cdc16e7",
  "status": "VERIFIED",
  "clientType": "INDIVIDUAL",
  "individualProfile": {
    "firstName": "Jack",
    "lastName": "Dowie",
    "email": "[email protected]",
    "phone": "[phone]",
    "address": "1, rue de la Paix",
    "city": "Paris",
    "postalCode": "75002",
    "countryCode": "FR",
    "occupation": "entrepreneur",
    "occupationDescription": null,
    "companyName": "DEF",
    "jobBusinessSector": "agriculture",
    "jobBusinessSectorDescription": null,
    "purposeOfOnboarding": "treasuryManagement",
    "idDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file1.pdf"
    ],
    "proofOfAddressDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file2.pdf"
    ],
    "proofOfAmlDocuments": [
      "rialto-clients/individuals/9c0306d5-e18e-4689-93da-997e2cdc16e7/26f7380a-dbf7-46a4-9568-7881cc8bfce7_file3.pdf"
    ]
  },
  "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,
  "companyDirectorsAndUbos": null,
  "onboardingResubmissionReason": null,
  "createdAt": "2024-12-03T10:07:54.940Z",
  "updatedAt": "2024-12-03T12:09:00.120Z",
  "deletedAt": "2024-12-03T12:09:00.120Z"
}