Skip to main content
POST
Create a customer

Authorizations

Authorization
string
header
required

Your API key, kp_test_… or kp_live_….

Body

application/json
externalId
string
required

Your own identifier for this person. Opaque to core, and rejected if it looks like an email address or a phone number — core is deliberately free of personal data.

Required string length: 1 - 200
Pattern: /^(?!.*@)(?!\+?[0-9][0-9 ()-]{8,}$).+$/
id
string

Optional. Supply one to share a single id between your systems and core — the same uuid then appears in both services' logs, and there is no mapping to keep. Core generates one when omitted.

assets
string[]

Optional. Accounts are normally opened on demand, when a customer actually needs an asset — pre-provisioning every asset for every customer derives deposit addresses nobody uses and grows the indexer's watch set for no benefit.

Pass assets here only when you already know which ones are needed.

metadata
object

Response