Appearance
POST Update customer's information
https://api.magmasend.com/v2/customer/:referenceThat allows you to update or change the current information of a customer.
Request Information
HEADERS
| Authorization | Bearer TOKEN |
|---|
Query Params
Path Variables
reference : 00F7831X00
Request Information
Here are the parameters you need to include in your request:
| Parameter Name | Type | Is Mandatory | Description |
|---|---|---|---|
| first_name | String | No | Customer’s first name. |
| last_name | String | No | Customer’s last name. |
| phone_number | String (E.164) | No | Customer’s phone number in international format. |
| birth_country | ISO2 country code | No | Two-letter country code of the customer's birth country. |
| birth_city | String | No | Name of the city where the customer was born. |
| birth_date | String (YYYY-MM-DD) | No | Customer’s date of birth in ISO format. |
| poi_type | String | No | Type of proof of identity (e.g: NationalID, Passport, DrivingLicense). |
| poi_id | String | No | Identification number shown on the provided proof of identity. |
| nationality | String | No | Customer’s origin country. |
| residence_country` | ISO2 country code | No | Two-letter country code of the customer's country of residence. |
| residence_city | String | No | City of residence. |
| `residence_address | String | No | Full street address or location of the customer's residence. |
Response Information
Here are the parameters you will receive in your response:
| Parameter Name | Type | Description |
|---|---|---|
| type | Enum (sender, receiver) | Type of customer. profile. |
| first_name | String | Customer’s first name. |
| last_name | String | Customer’s last name. |
| phone_number | String (E.164) | Customer’s phone number in international format. |
| birth_country | ISO2 country code | Two-letter country code of the customer's birth country. |
| birth_city | String | Name of the city where the customer was born. |
| birth_date | String (YYYY-MM-DD) | Customer’s date of birth in ISO format. |
| poi_type | String | Type of proof of identity |
| poi_id | String | Identification number shown on the provided proof of identity. |
| nationality | String | Customer’s origin country. |
| country | ISO2 country code | Two-letter country code of the customer's country of residence. |
| city | String | City of residence. |
Example Request
Curl
curl --location --globoff 'https://api.magmasend.com/v2/customer/00F7831X00' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token' \
--data '{
"first_name": "John",
"last_name": "Doe",
"phone_number": "+22507010203",
"birth_country": "GB",
"birth_city": "London",
"birth_date": "1990-01-01",
"poi_type": "NationalID",
"poi_id": "123456789",
"nationality": "CI",
"residence_country": "GB",
"residence_city": "London",
"residence_address": "Abchurch Lane and Abchurch Yard"
}'Example body request
json
{
"first_name": "John",
"last_name": "Doe",
"phone_number": "+22507010203",
"birth_country": "GB",
"birth_city": "London",
"birth_date": "1990-01-01",
"poi_type": "NationalID",
"poi_id": "123456789",
"nationality": "CI",
"residence_country": "GB",
"residence_city": "London",
"residence_address": "Abchurch Lane and Abchurch Yard"
}
Example success Response
{
"code": 202,
"status": "ACCEPTED",
"comment": "Customer updated successfully",
"customer": {
"type": "sender",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+22507010203",
"birth_country": "GB",
"birth_city": "London",
"birth_date": "1990-01-01",
"poi_type": "NationalID",
"poi_id": "123456789",
"nationality": "CI",
"country": "GB",
"city": "London"
}
}
Example failed Response
{
"code": 404,
"status": "NOT_FOUND",
"comment": "reference you requested does not exist"
}