Update Account
PATCH /api/v2/directory/accounts/{reference_id}
This endpoint is utilized to modify/update the details of a specific account identified by reference_id.
Path Parameters
Name
Type
Description
Required
reference_id
string
Unique identifier for the account, previously external_id. Example: transfer7890
True
Body
Name
Type
Description
Required
field
array
The name of the field to be updated. Examples: individual, individual_name, name_first
True
value
string, integer, date
The value of the field to be updated to. Example: Mark
fields
array
An array of the fields to be updated.
Sample Request
{
"fields": [
{
"field": [
"individual",
"individual_name",
"name_first"
],
"value": "John"
},
{
"field": [
"individual",
"individual_name",
"name_last"
],
"value": "Doe"
},
{
"field": [
"email"
],
"value": "[email protected]"
}
]
}{
"status": "success",
"data": {
"reference_id": "johndoe",
"account_type": "individual",
"email": "[email protected]",
"individual": {
"individual_name": {
"name_type": "LEGL",
"name_first": "John",
"name_middle": "Mark",
"name_last": "Doe"
},
"individual_localname": {
"name_type": "LEGL",
"name_first": "John",
"name_middle": "Mark",
"name_last": "Doe"
},
"date_of_birth": "1988-06-27",
"place_of_birth": "Singapore, Singapore",
"nationality_country": "SG",
"residence_country": "SG"
},
"address": {
"address_type": "GEOG",
"address_line": "Apt 123",
"address_street_no": "456",
"address_street_name": "Elm Street",
"address_building_name": "Elmwood Apartments",
"address_floor": "15",
"address_room": "1503",
"address_department": null,
"address_subdepartment": null,
"address_postbox": "PO Box 789",
"address_city_location": null,
"address_city": "New York",
"address_region": "New York",
"address_district": "Manhattan",
"address_postcode": "10001",
"address_country_code": "US"
},
"created": "2024-02-26 21:57:18.000 +0800",
"last_modified": "2024-02-27 10:37:20.000 +0800"
}
}Last updated