BRbridge
Customers

Update a single customer object

Changed on

Updates to be made to the specified customer.

No fields are strictly required by the API. It is generally valid to provide any subset of data in a PUT request. For business customers, associated persons cannot be updated via PUT, and should instead be managed using v0/associated_persons.

put/customers/{customerID}

Request

  • Base URL
    https://api.bridge.xyz/v0
  • URL
    https://api.bridge.xyz/v0/customers/{customerID}
  • Auth
    API key in header Api-Key

Request body

OR

Response

Successful customer object response

idstring

A UUID that uniquely identifies a resource

first_namestring
middle_namestring nullable
last_namestring
emailstring
status'active' | 'awaiting_questionnaire' | 'awaiting_ubo' | 'deposits_restricted' | 'incomplete' | 'not_started' | 'offboarded' | 'paused' | 'rejected' | 'under_review'

offboarded: represents a customer's account that was internally reviewed and closed due to suspicious activity. paused: represents a customer's account that is currently under review because of activity on the platform. deposits_restricted: represents a customer's account that is currently restricted from making new deposits because of activity on the platform.

future_requirements_duestring[]

This field is deprecated. See endorsements.missing instead.

requirements_duestring[]

KYC requirements still needed to be completed. Please consult our KYC guide on how to resolve each requirement.

created_atstring date-time

Time of creation of the customer

updated_atstring date-time

Time of last update of the customer

has_accepted_terms_of_serviceboolean

Whether the customer has accepted the terms of service.

client_reference_idstring

A client-provided reference ID that uniquely identifies a resource in the client's system

Changes

  • a390532e9fc6Revision changes
    • warning

      removed the request property /

    • warning

      added the new deposits_restricted enum value to the response property for the response status

    • info

      added individual business mapping keys to the request discriminator

    • info

      request property / deprecated

    • info

      added the optional property to the response with the status