Skip to main content

Fetch Customer Information

Look up the Azotte projection of a customer by either side of the identity link.

URL

GET /api/c2a/customer/info

Request Parameters

NameTypeDescription
urnstringQuery parameter, conditional. Azotte CustomerUrn. Provide either urn or exId. If both supplied, urn takes precedence.
exIdstringQuery parameter, conditional. Tenant ExternalIdentifier. Provide either urn or exId.

Response Parameters

FetchCustomerInfoResponse wraps AzotteCustomerSnapShot — read-optimised projection containing identity, addresses, privacy state, subscription summary counts, and CustomerOptions.

NameTypeDescription
resultobject (AzotteCustomerSnapShot)Snapshot record.
result.customerUrnstringAzotte URN.
result.externalIdentifierstringTenant ExternalId.
result.emailstringEmail.
result.statusstringOperational status.
result.optionsobject (CustomerOptions)Caller-facing rules.
result.options.availableChannelsstring[]Payment channels available to this customer.
result.options.canSavePaymentMethodbooleanWhether the customer can tokenize a card.
statusobject (AzotteStatus)Operation status envelope.

Sample Response

{
"result": {
"customerUrn": "cu.00.482",
"externalIdentifier": "crm-9981273",
"email": "jane.doe@example.com",
"status": "Active",
"options": {
"availableChannels": ["CARD", "SEPA"],
"canSavePaymentMethod": true
}
},
"status": { "messageCode": "SUCCESS" }
}

Sample Codes

curl --location --request GET \
'https://acme.sandbox.azotte.com/api/v1/c2a/customer/info?urn=cu.00.482' \
--header 'x-tn: e2a1c7b2-4f3a-4b8e-9c2d-1a2b3c4d5e6f' \
--header 'x-api-key: sk_dev_acme_sample_123456789'