The endpoint allows you to update a client profile. To identify profile/client a valid combination of email_address
and mobile_number
is required. A json object is required to be posted as raw body. See example request, response objects and authentication process. The full API URL is :
POST https://authified.com/api/v1/profile/update
Name | Type | Description |
---|---|---|
/email_address | string(45) | A valid email address, unique for each customer - (required) |
/mobile_number | string(10) | A valid US/CAN 10 digit, without country code mobile phone number, unique for each customer - (required) |
/merchant_reference | string(100) | Reference number provided by the merchant - (optional) |
/customer_id | string(100) | Customer Id provided by the merchant - (optional) |
/first_name | string(45) | Client's first name - (required) |
/middle_name | string(45) | Client's middle name - (optional) |
/last_name | string(45) | Client's last name - (required) |
/date_of_birth | date(10) | Client's date of birth - (optional) |
/home_phone_number | string(10) | A valid US/CAN 10 digit, without country code hoe phone number - (optional) |
/ip_address | string(45) | A Client's valid IP Address - (optional) |
/address_line_1 | string(100) | A Client's physical Address Line 1 - (optional) |
/address_line_2 | string(100) | A Client's physical Address Line 2 - (optional) |
/city | string(45) | A Client's city - (optional) |
/state | string(2) | A Client's state code, A valid ISO alpha 2 code - (optional) |
/postal | string(10) | A Client's postal/zip code - (optional) |
/country | string(2) | A Client's country code, A valid ISO alpha 2 code - (optional) |
/driver_licence_id | string(100) | A Client's driver licence id - (optional) |
/ssn | string(9) | A Client's SSN (social insurance number) - (optional) |
{
"merchant_reference": "",
"customer_id": "",
"first_name": "",
"middle_name": "",
"last_name": "",
"date_of_birth": "",
"email_address": "",
"mobile_number": "",
"home_phone_number": "",
"ip_address": "",
"address_line_1": "",
"address_line_2": "",
"city": "",
"state": "",
"postal": "",
"country": "",
"amount": "",
"driver_licence_id": "",
"ssn": ""
}
{
"http_status_code": 200,
"query_reference_id": "",
"response_time": "0.00",
"query_at": "",
"profile": {
"merchant_reference": "",
"customer_id": "",
"first_name": "",
"middle_name": "",
"last_name": "",
"date_of_birth": "",
"email_address": "",
"mobile_number": "",
"home_phone_number": "",
"ip_address": "",
"address_line_1": "",
"address_line_2": "",
"city": "",
"state": "",
"postal": "",
"country": "",
"amount": "",
"driver_licence_id": "",
"ssn": "",
"created_at": "",
"updated_at": ""
}
}
curl --location --request POST 'https://authified.com/api/v1/profile/update' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Api-Key: ' \
--header 'Signature: ' \
--data-raw '{
"merchant_reference": "",
"customer_id": "",
"first_name": "",
"middle_name": "",
"last_name": "",
"date_of_birth": "",
"email_address": "",
"mobile_number": "",
"home_phone_number": "",
"ip_address": "",
"address_line_1": "",
"address_line_2": "",
"city": "",
"state": "",
"postal": "",
"country": "",
"driver_licence_id": "",
"ssn": ""
}'
POST /api/v1/profile/update HTTP/1.1
Host: https://authified.com
Accept: application/json
Content-Type: application/json
Api-Key:
Signature:
Content-Length:
{
"merchant_reference": "",
"customer_id": "",
"first_name": "",
"middle_name": "",
"last_name": "",
"date_of_birth": "",
"email_address": "",
"mobile_number": "",
"home_phone_number": "",
"ip_address": "",
"address_line_1": "",
"address_line_2": "",
"city": "",
"state": "",
"postal": "",
"country": "",
"amount": "",
"driver_licence_id": "",
"ssn": ""
}
var settings = {
"url": "https://authified.com/api/v1/profile/update",
"method": "POST",
"timeout": 0,
"headers": {
"Accept": "application/json",
"Content-Type": "application/json",
"Api-Key": "",
"Signature": ""
},
"data": JSON.stringify({"merchant_reference":"","customer_id":"","first_name":"","middle_name":"","last_name":"","date_of_birth":"","email_address":"","mobile_number":"","home_phone_number":"","ip_address":"","address_line_1":"","address_line_2":"","city":"","state":"","postal":"","country":"","driver_licence_id":"","ssn":""}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var data = JSON.stringify({"merchant_reference":"","customer_id":"","first_name":"","middle_name":"","last_name":"","date_of_birth":"","email_address":"","mobile_number":"","home_phone_number":"","ip_address":"","address_line_1":"","address_line_2":"","city":"","state":"","postal":"","country":"","driver_licence_id":"","ssn":""});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://authified.com/api/v1/profile/update");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Api-Key", "");
xhr.setRequestHeader("Signature", "");
xhr.send(data);
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://authified.com/api/v1/profile/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS =>'{
"merchant_reference": "",
"customer_id": "",
"first_name": "",
"middle_name": "",
"last_name": "",
"date_of_birth": "",
"email_address": "",
"mobile_number": "",
"home_phone_number": "",
"ip_address": "",
"address_line_1": "",
"address_line_2": ",
"city": "",
"state": "",
"postal": "",
"country": "",
"driver_licence_id": "",
"ssn": ""
}',
CURLOPT_HTTPHEADER => array(
"Accept: application/json",
"Content-Type: application/json",
"Api-Key: ",
"Signature: "
),
));
$response = curl_exec($curl);
$http_code = curl_getinfo($url, CURLINFO_HTTP_CODE);
curl_close($url);
if ($http_code === 200):
echo $response;
else:
echo "Un-expected server response http_code($http_code)<br/>$response";
endif;
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://authified.com/api/v1/profile/update');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Accept' => 'application/json',
'Content-Type' => 'application/json',
'Api-Key' => '',
'Signature' => ''
));
$request->setBody('{\n "merchant_reference": "",\n "customer_id": "",\n "first_name": "",\n "middle_name": "",\n "last_name": "",\n "date_of_birth": "",\n "email_address": "",\n "mobile_number": "",\n "home_phone_number": "",\n "ip_address": "",\n "address_line_1": "",\n "address_line_2": "",\n "city": "",\n "state": "",\n "postal": "",\n "country": "",\n "driver_licence_id": "",\n "ssn": ""\n}');
try {
$response = $request->send();
if ($response->getStatus() === 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}