Upload an account

Authorizations

Authorization

string

header

required

Source-bound WorkOS API key or configured machine OIDC token. OIDC webhook management requires karsa:webhooks:manage.

Headers

Idempotency-Key

string

required

Stable source submission identifier, unique for this source and route

Required string length: 1 - 200

Example:

"01J9ZQ2YD15Y2YZ5H0W3J7D3E2"

Body

application/json

externalId

string

required

Required string length: 1 - 200

effectiveAt

string<date-time>

required

accountType

string

required

Required string length: 1 - 200

customerId

string | null

required

Required string length: 1 - 200

status

string | null

required

Required string length: 1 - 200

openedAt

string<date-time> | null

required

customData

object | null

required

Hide child attributes

customData.{key}

any

documents

object[]

required

Maximum array length: 25

Hide child attributes

documents.documentVersionId

string

required

Required string length: 1 - 200

documents.role

string

required

Required string length: 1 - 200

documents.roleDetail

string | null

Required string length: 1 - 200

sourceExternalId

string | null

Required string length: 1 - 200

changeReason

string | null

Required string length: 1 - 500

accountKind

enum<string>

Defaults to OTHER for a new account; omission on a later POST preserves the current immutable kind

Available options:

BANK_ACCOUNT,

VIRTUAL_ACCOUNT,

BLOCKCHAIN_WALLET,

CUSTODIAL_WALLET,

OFFRAMP_WALLET,

OTHER

accountDetails

object | null

Hide child attributes

accountDetails.displayName

string | null

required

Required string length: 1 - 500

accountDetails.country

string | null

required

Required string length: 1 - 200

accountDetails.assets

string[]

required

Maximum array length: 25

Required string length: 1 - 200

accountDetails.paymentRails

string[]

required

Maximum array length: 25

Required string length: 1 - 200

accountDetails.bank

object | null

required

Hide child attributes

accountDetails.bank.accountHolderName

string | null

required

Required string length: 1 - 500

accountDetails.bank.accountClass

string | null

required

Required string length: 1 - 200

accountDetails.bank.recipientRelationship

string | null

required

Required string length: 1 - 200

accountDetails.bank.institutionName

string | null

required

Required string length: 1 - 500

accountDetails.bank.institutionAddress

object | null

required

Hide child attributes

accountDetails.bank.institutionAddress.line1

string | null

required

Required string length: 1 - 500

accountDetails.bank.institutionAddress.line2

string | null

required

Required string length: 1 - 500

accountDetails.bank.institutionAddress.city

string | null

required

Required string length: 1 - 200

accountDetails.bank.institutionAddress.region

string | null

required

Required string length: 1 - 200

accountDetails.bank.institutionAddress.postalCode

string | null

required

Required string length: 1 - 200

accountDetails.bank.institutionAddress.country

string | null

required

Required string length: 1 - 200

accountDetails.bank.beneficiaryAddress

object | null

required

Hide child attributes

accountDetails.bank.beneficiaryAddress.line1

string | null

required

Required string length: 1 - 500

accountDetails.bank.beneficiaryAddress.line2

string | null

required

Required string length: 1 - 500

accountDetails.bank.beneficiaryAddress.city

string | null

required

Required string length: 1 - 200

accountDetails.bank.beneficiaryAddress.region

string | null

required

Required string length: 1 - 200

accountDetails.bank.beneficiaryAddress.postalCode

string | null

required

Required string length: 1 - 200

accountDetails.bank.beneficiaryAddress.country

string | null

required

Required string length: 1 - 200

accountDetails.bank.identifiers

object[]

required

Maximum array length: 50

Hide child attributes

accountDetails.bank.identifiers.type

string

required

Required string length: 1 - 200

accountDetails.bank.identifiers.value

string

required

Required string length: 1 - 500

accountDetails.bank.identifiers.paymentRail

string | null

Required string length: 1 - 200

accountDetails.bank.beneficiaryIndustry

object | null

Hide child attributes

accountDetails.bank.beneficiaryIndustry.system

enum<string>

required

Available options:

NAICS,

NACE,

ISIC,

MCC,

OTHER

accountDetails.bank.beneficiaryIndustry.systemSourceText

string | null

required

Required string length: 1 - 500

accountDetails.bank.beneficiaryIndustry.code

string | null

required

Required string length: 1 - 80

accountDetails.bank.beneficiaryIndustry.label

string | null

required

Required string length: 1 - 500

accountDetails.wallet

object | null

required

Hide child attributes

accountDetails.wallet.network

string | null

required

Required string length: 1 - 200

accountDetails.wallet.address

string | null

required

Required string length: 1 - 500

accountDetails.wallet.custodyType

string | null

required

Required string length: 1 - 200

accountDetails.wallet.isAccountAbstraction

boolean | null

required

accountDetails.wallet.signatureTransactionHash

string | null

Required string length: 1 - 500

Maximum array length: 25

Hide child attributes

Required string length: 1 - 200

Response

A new immutable version was appended to an existing identity

outcome

enum<string>

required

Available options:

CREATED,

VERSION_CREATED

resourceId

string

required

Minimum string length: 1

versionId

string

required

Minimum string length: 1

currentVersionId

string | null

required

Minimum string length: 1

Customers

Verifications

Accounts

Documents

Transactions

Sources

Outcomes

Screening

Controls

Requests

Webhooks

Authorizations

Headers

Body

Response