Update person or company customer

patch

https://sandbox.pismolabs.io/accounts/v1/accounts/{accountId}/customers/{customerId}/detail

Update the account's person or company customer information.

Fields not passed are not updated.

This endpoint generates an Account entity updated event.

If the customer.is_owner property is set to true:

The account owner is changed to this new customer, and all existing customers remain active in the account.
This endpoint generates an Account owner changed event.

If customer.is_active = true, and the Maximum number of card holders program parameter is set, this customer is counted in the limit of maximum number of card holders for an account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

int64

required

≥ 1

Account ID

customerId

int64

required

Customer ID

Body Params

Customer properties to update

name

string

Name

nickname

string

length ≤ 128

Nickname.

printed_name

string

length ≤ 25

deprecated

This field is DEPRECATED. Cards is now responsible for this field.

Person's name to be printed on the card. If the field is null, name or social_name is used.

Punctuation, special characters, and connectors (da/das/de/do/dos/e) are always removed.

This field's maximum lengh of this field is 25, but you can set it to a lower value on the program level with the Max name length on physical card program parameter.

social_name

string

length ≤ 64

Social name.

string

length ≤ 100

Email address.

pep

boolean

Is this person a Politically Exposed Person (PEP)? Pismo doesn't do anything differently for a PEP, this is just additional account information. Default is false.

gender

string

enum

length ≤ 1

Gender

Allowed:

marital_status

string

enum

Marital status

Allowed:

mothers_name

string

length ≤ 60

Mother's name

nationality

string

length ≤ 60

Nationality

city_of_birth

string

length ≤ 60

Birth city

state_of_birth

string

length ≤ 60

Birth state

country_of_birth

string

length ≤ 60

Birth country

other_id_number

string

Another ID number

document_type

string

length ≤ 30

Document type. Free-form field, not an enum.

document_issued_by

string

length ≤ 30

Document issuer

document_issued_at

string

length ≤ 30

Document issuer location. This is a free-form field, not an ISO standard.

document_issued_date

string

Date document was issued. Format = dd/mm/yyyy.

fathers_name

string

length ≤ 60

Father's name

occupation

string

length ≤ 60

Person's occupation

assets

float

Assets

income

float

Person's income

net_worth

float

Person's net worth

birth_date

string

Birth date. Format = dd/mm/yyyy.

is_owner

boolean

Is customer the account owner?

is_active

boolean

Is customer active?

Headers

x-cid

string

The Correlation IDentifier field is used to link related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. You can find the x-cid field in the response header from an API endpoint call.

If this field isn't passed, one is automatically generated.

x-tenant

string

required

Organization ID

Responses

Update person or company customer

Changelog

Support

Pismo is here to help

200Customer details were successfully updated

404Not found

500Internal server error