Customers

Update a customer's profile and classification

Changed on Nov 3, 2026

The main onboarding call. Everything that describes a customer is set here rather than at creation.

Use this endpoint to set:

Classification. customerType, accountType, customerArchetypes, useCases and kycRelianceModel.
Legal identity. Registered name, trade name, incorporation country and date, registration number.
Addresses. Four distinct roles: registered, physical, mailing and tax.
Declared activity. Source of funds, expected volumes, operating countries and the rest of the risk profile.

Changing customerArchetypes after approval counts as a material change. Follow it with POST /v1/customers/{customerId}/reevaluate.

put/v1/customers/{customerId}

Request

Base URL
https://api.sandbox.alfredpay.io
URL
https://api.sandbox.alfredpay.io/v1/customers/{customerId}
Auth
- HTTP bearer
- or API key in header api-key and API key in header api-secret

Request body

customerType'CUSTOMER' | 'THIRD_PARTY_CUSTOMER' | 'SUB_CUSTOMER'

accountType'PARTNER' | 'DIRECT_CUSTOMER'

customerArchetypesCustomerArchetype[]

useCasesUseCase[]

kycRelianceModel'FULL_RELIANCE' | 'SEMI_RELIANCE' | 'NON_RELIANCE'

legalNamestring

tradeNameDbastring

businessTypestring

businessDescriptionstring

incorporationCountry'MEX' | 'ARG' | 'BRA' | 'COL' | 'CHL' | 'PER' | 'DOM' | 'USA' | 'CHN' | 'HKG' | 'BOL' | 'PRY'

ISO 3166-1 alpha-3, the only form Alfred stores, filters on, reports or emits. Compatibility rule for integrations that can only send alpha-2: any inbound country value in alpha-2 (path, query or body) is normalized to alpha-3 at the boundary before validation, storage or routing. Unrecognized in either form → 422 validation_error.

incorporationDatestring date

businessRegistrationNumberstring

residencyCountry'MEX' | 'ARG' | 'BRA' | 'COL' | 'CHL' | 'PER' | 'DOM' | 'USA' | 'CHN' | 'HKG' | 'BOL' | 'PRY'

industryCodesstring[]

websiteUrlsstring[]

emailstring email

phonestring

accountPurposesAccountPurpose[]

accountPurposeOtherstring

sourceOfFundsstring

sourceOfFundsDescriptionstring

sourceOfWealthstring

expectedMonthlyVolumeUsdstring

expectedTransactionCountinteger

operatingCountriesCountryCode[]

destinationOfFundsstring

counterpartyRelationshipstring

ownFundsVsClientFunds'OWN_FUNDS' | 'CLIENT_FUNDS' | 'BOTH'

actsOnOwnBehalfboolean

regulatedActivityboolean

highRiskActivitiesstring[]

highRiskActivitiesExplanationstring

prohibitedJurisdictionExposureboolean

controlPersonRequiredboolean

declaredFinancialsCurrency'USD' | 'HKD' | 'CNY' | 'MXN' | 'DOP' | 'COP' | 'BRL' | 'ARS' | 'CLP' | 'PEN' | 'BOB' | 'PYG' | 'USDC' | 'USDT'

Fourteen members, reconciled to the countries a customer can be onboarded in. USDC and USDT are stablecoins and require chain.

acceptTosboolean

Response