Update a customer's profile and classification

put

https://api.sandbox.alfredpay.io/v1/customers/{customerId}

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

string

required

Body Params

customerType

string

enum

Allowed:

accountType

string

enum

Allowed:

customerArchetypes

array of objects

length ≥ 1

customerArchetypes

useCases

array of objects

useCases

kycRelianceModel

string

enum

Allowed:

legalName

string

tradeNameDba

string

businessType

string

businessDescription

string

incorporationCountry

string

enum

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.

incorporationDate

date

businessRegistrationNumber

string

residencyCountry

string

enum

industryCodes

array of strings

industryCodes

websiteUrls

array of uris

websiteUrls

registeredAddress

object

physicalAddress

object

mailingAddress

object

taxAddress

object

string

phone

string

accountPurposes

array of objects

accountPurposes

Allowed:

accountPurposeOther

string

sourceOfFunds

string

sourceOfFundsDescription

string

sourceOfWealth

string

expectedMonthlyVolumeUsd

string

expectedTransactionCount

integer

operatingCountries

array of objects

operatingCountries

destinationOfFunds

string

counterpartyRelationship

string

ownFundsVsClientFunds

string

enum

Allowed:

actsOnOwnBehalf

boolean

regulatedActivity

boolean

highRiskActivities

array of strings

highRiskActivities

highRiskActivitiesExplanation

string

prohibitedJurisdictionExposure

boolean

controlPersonRequired

boolean

declaredFinancialsCurrency

string

enum

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

acceptTos

boolean

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Malformed request, so a missing required field, a wrong type or a bad enum.

404The resource does not exist, or belongs to another partner.

422Semantically invalid. The request is well-formed but violates a business rule. param names the field.