The Alviere Platform supports updateable Metadata on select objects allowing you to add information to the request. This is available using the metadata parameter.

Metadata can be useful for storing additional, structured information on an entity. For example - you could store your user's internal account number and corresponding unique identifier from your system on a Alviere Account entity.

Note: Any Metadata provided in the request is not used by Alviere. The field is reserved for your use to make your overall integration architecture more efficient.

Metadata takes the form of free-form key-value pairs. You may send Metadata for select methods when you create an object (POST) and when updating an object (PATCH).

We do not recommend submitting any sensitive information (i.e. bank account numbers, card details, complete social security numbers, etc.) as Metadata.

Example with added Metadata:

• PATCH {url}/accounts/{account_uuid}

{ "information": { "consumer_information": { "first_name": "John", "middle_name": "Smith", "last_name": "Doe", "date_of_birth": "1976-02-07", "ssn": "123456789", "phone_number": "+19176159179", "email_address": "john.doe@alviere.com" } }, "metadata": { "customer_id": "35082920" }, "external_id": "string" }

If you would like to remove metadata that is already on an object, you can send a PATCH with an empty key {}.

Example removing metadata:

• PATCH {url}/accounts/{account_uuid}

{ "information": { "consumer_information": { "first_name": "John", "middle_name": "Smith", "last_name": "Doe", "date_of_birth": "1976-02-07", "ssn": "123456789", "phone_number": "+19176159179", "email_address": "john.doe@alviere.com" } }, "metadata": {}, "external_id": "string" }

Example use cases for Metadata:

• Link IDs - attach your system's unique ID to an available Alviere entity allowing for easy lookups. For example - add a customer ID to an Alviere Account or add a location to Load or Withdrawal Funds, your promo code to Create Card, etc.

• Customer specifics - add notes about a customer by storing your internal ID and comments.