Update a Client
PUT {{baseurl}}/v1/api/actors/:actorId
This endpoint allows you to update a client, also known as an actor or entity, depending on your nomenclature. The client is an individual or a business that you have a business or commercial relationship with.
Header
token*
String
API token
Body
firstName*
String
First name of the actor
lastName*
String
Last name of the actor
middleName*
String
Middle name of the actor
gender*
String
The gender of the actor. This can be either male or female
nationality*
String
The nationality type of the actor. This is the ISO alpha-2 country code: US
sourceOfIncome*
String
The source of income of the actor. This can be: earned income, investment income, interest and dividend income, rental income, business income, capital gains, retirement income, self-employment, royalty and intellectual property income, others
occupation*
String
The occupation of the actor
industry*
String
The industry of the actor's occupation
customerSegmentation*
String[]
An array of strings of actor categories based on the business customer segmentation. This can be: high_risk, low_risk, medium_risk, high_net_worth, high_income
dateOfBirth*
String
The date of birth of the actor. This is represented using the JIS format YYYY-MM-DD
accountNumbers*
Object[]
An array of account numbers that belong to the actor
accountType*
String
The type of account. It can be: savings,current
accountNumber*
String
The account number
domicile
String
The country code where the account is domiciled. This is the ISO alpha-2 country code: US
accountCreationDate*
String
The date the account number was created. This is represented using the JIS format YYYY-MM-DD
phones*
Object[]
An array of phone numbers belonging to the actor
numberType
String
The type of phone number: can be "personal" or "office"
countryCode*
String
This is the international dialling code of the corresponding country. US:1
phone*
String
The phone number: 07100000000
socials
Object[]
The array of social media accounts belonging to the actor
type
String
The social media platform of the social account
handle
String
The social media handle of the social account
emails*
Object[]
The array of email addresses belonging to the actor
emailType
String
The type of email account: can be, "personal" or "office"
address*
String
The address of the email account
governmentIds*
Object[]
The array of government IDs belonging to the actor
idType*
String
Type of ID
value*
String
The ID number
issuingAuthority
String
The organisation issuing the ID
expirationDate
String
The date the ID expires. This is represented using the JIS format YYYY-MM-DD
addresses*
Object[]
The array of addresses belonging to the actor
addressType
String
The type of address: This can be home or office
line1*
String
Address line 1
line2
String
Address line 2
postCode*
String
post/zip code of the address
city*
String
Address city
state*
String
Address state/province
country*
String
address country
lengthOfStay*
String
The length of stay at the address: in months
legalEntity*
Object
the details of the incorporation
dateOfRegistration
String
The date the business was registered. This is represented using the JIS format YYYY-MM-DD
type*
String
The type of business entity. This can be a:
limited_liability, sole_proprietorship, general_partnership, limited_partnership, corp, non_profit, co_op
registrationNumber*
String
The business registration number
industryClasssification*
String
The industry of the business
url
String
The website URL of the business
countryOfIncorporation
String
The country the business was incorporated. This is the ISO alpha-2 country code: US
legalEntityDirectors*
Object[]
The details of the directors of the business
name*
String
The name of the director. This is represented as: first_name and last_name
sourceOfIncome*
String
The source of income of the director. This can be: earned income, investment income, interest and dividend income, rental income, business income, capital gains, retirement income, self-employment, royalty and intellectual property income, others
phone*
String
The phone number of the director
emails*
String[]
The array of emails belonging to the director
uniqueIdentifier*
Object[]
The ID of the director
idType*
String
The type of ID
idNumber*
String
The number of the ID
Last updated