Upload private owner ID PDF, JPEG, or PNG (owner only, live mode; max 5 MiB)

PUT

/dashboard/v1/merchants/{merchantId}/{mode}/onboarding/owner-id

curl --request PUT \
  --url http://localhost:4000/dashboard/v1/merchants/example/test/onboarding/owner-id \
  --header 'Content-Type: application/pdf' \
  --header 'idempotency-key: example' \
  --cookie better-auth.session_token=<better-auth.session_token> \
  --data binary

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

Header Parameters

idempotency-key

required

Required retry-safe key; reuse it only for the same operation and request body

string

>= 1 characters <= 255 characters

Required retry-safe key; reuse it only for the same operation and request body

Request Body^required

string format: binary

string format: binary

string format: binary

Responses

201

Document stored privately

Media typeapplication/json

object

object

required

string

Allowed values: kyc_document

id

required

string

content_type

required

string

Allowed values: application/pdf image/jpeg image/png

size_bytes

required

integer

status

required

string

Allowed values: uploading ready

created_at

required

string

Example

{
  "object": "kyc_document",
  "content_type": "application/pdf",
  "status": "uploading"
}

400

Invalid request

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Sign-in required

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Forbidden

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Not found

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Idempotency conflict or invalid state

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}