Skip to content

POST Update customer's information

https://api.magmasend.com/v2/customer/:reference

That allows you to update or change the current information of a customer.

Request Information

HEADERS

AuthorizationBearer TOKEN

Query Params

Path Variables

reference : 00F7831X00

Request Information

Here are the parameters you need to include in your request:

Parameter NameTypeIs MandatoryDescription
first_nameStringNoCustomer’s first name.
last_nameStringNoCustomer’s last name.
phone_numberString (E.164)NoCustomer’s phone number in international format.
birth_countryISO2 country codeNoTwo-letter country code of the customer's birth country.
birth_cityStringNoName of the city where the customer was born.
birth_dateString (YYYY-MM-DD)NoCustomer’s date of birth in ISO format.
poi_typeStringNoType of proof of identity (e.g: NationalID, Passport, DrivingLicense).
poi_idStringNoIdentification number shown on the provided proof of identity.
nationalityStringNoCustomer’s origin country.
residence_country`ISO2 country codeNoTwo-letter country code of the customer's country of residence.
residence_cityStringNoCity of residence.
`residence_addressStringNoFull street address or location of the customer's residence.

Response Information

Here are the parameters you will receive in your response:

Parameter NameTypeDescription
typeEnum (sender, receiver)Type of customer. profile.
first_nameStringCustomer’s first name.
last_nameStringCustomer’s last name.
phone_numberString (E.164)Customer’s phone number in international format.
birth_countryISO2 country codeTwo-letter country code of the customer's birth country.
birth_cityStringName of the city where the customer was born.
birth_dateString (YYYY-MM-DD)Customer’s date of birth in ISO format.
poi_typeStringType of proof of identity
poi_idStringIdentification number shown on the provided proof of identity.
nationalityStringCustomer’s origin country.
countryISO2 country codeTwo-letter country code of the customer's country of residence.
cityStringCity 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"
}