An overview of relation between Customer and addressess.
The addresses linked to Customers are used by the platform (based on Merchant products) to facilitate communication and data exchange with the Customer.
Multiple addresses can be linked to a single Customer. Addresses associated with Customers can be used to login to wallet.authvia.com to process the Business Processes sent by the Account](account) (merchant).
Example
Given the following Customer create payload.
{
ref: "CUSTOMER_REFERENCE",
addresses: [
{ "value": "+11234567890" },
{ "value": "[email protected]" },
],
metadata: { name: "John Doe" }
}
Given the following Customer response payload.
{
ref: "CUSTOMER_REFERENCE",
Merchant: "AVID0000-0000-0000-0000-000000000000",
defaultAddress: "+11234567890",,
metadata: { name: "John Doe" }
}
Although a Customer can have multiple addresses, the first address in the list will be designated as the defaultAddress
and will be used when no specific address is provided for messages or payment request.
How to update defaultAddress to new address? To update the new default address, utilize replace customer addresses which allows for completely replacing the old addresses associated with the Customer with a new set of addresses.
Note: The first address in the new set of addresses always serves as the defaultAddress.
To list all the linked addresses associated with a Customer within an Account](account)(merchant), please use list-customer-addresses
Each address associated with a Customer has a status, each with its own meaning. Here they are:
{
"value": "+11234567890",
"type": "phone",
"subType": "unknown",
"status": "known" // other possible status - claimed - deactivated - invalid
}
known** - We acknowledge the validity of this address; however, we have not detected any unfamiliar activity associated with it. claimed - A user has placed a claim on this address deactivated - We have been informed that this address was deactivated, and we need to disassociate all user information so it can be reclaimed later by another user. invalid - This means the address was returned as invalid by the validation service.