Update an existing customer

Modify a customer's existing information or provide values for optional fields that were not set during initial creation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Identifier type for the entity. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:
string
required

The identifier value corresponding to the selected identifier type.

Body Params

Fields to update on the customer record.

string

Reference id assigned by the program manager.

string
enum

The customer type.

Allowed:
individual
object

Details of the individual customer.

business
object

Details of the business customer.

string
enum

Preferred mode of communication for the customer.

Allowed:
boolean

Indication of customer’s consent to receive all communication via email.

linkedDocument
array of objects

Identification documents for the customer.

linkedDocument
programAffiliate
object

Program affiliate under whom the customer is onboarded.

Headers
string
enum
required

Required. Set to NEVER for a synchronous response or ALWAYS for asynchronous processing.

Allowed:
Responses

202

The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs. Expected for all requests with PromiseMode as ALWAYS.

204

The Passport server successfully processed the request and is not returning any content. This is expected for all updates, deletion requests on the resources.

299

The Passport server successfully processed the request i.e. the object has been created or modified as requested, however the action may have an impact on transacting which is notified in the warning.

400

The request could not be accepted by the Passport server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json