Sign in

v1

latestOpenAPI 3.0.02026-07-1427437.7 KB
Addresses

Get unmasked address by version

Retrieves unmasked information of a specific address version of a given client.

Learn more about the Profile System and its other API endpoints.

get/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId}/unmask

Path parameters

profileIdstring required
Example:70caf394-8534-447e-a0ca-1803c669c771

ID of the client's profile as returned by the Create profile endpoint's response, in the id field. It can also be an alternativeKey according to your custom profile schema. In this case, this request should also send the alternativeKey parameter.

addressIdstring required
Example:bf82180e-cf9e-4089-9af6-ae1518555992

ID of a client's specific address as returned in the Create client address endpoint's response, in the id field.

addressVersionIdstring required
Example:86dfae79-1d23-43f2-a643-2fc8f1839461

ID of the version of a given client's address as returned by endpoints that create or update address information in the version field.

Query parameters

reasonstring required
Example:data-validation

Reason for requesting unmasked data.

alternativeKeystring
Example:email

The profileId path parameter may be substituted by other profile fields in this request. When making this request, send the alternativeKey parameter with a value equal to the key of the field you wish to use as profileId.

Currently, there are two possible values for this parameter: email and document.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

object required