POST
/
customers
/
{id}
/
documents
curl --request POST \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/customers/{id}/documents \
  --header 'Content-Type: multipart/form-data' \
  --form 'document_number=<string>' \
  --form 'kyc_document_id=<string>' \
  --form 'note=<string>'
{
  "message": "<string>",
  "success": true,
  "content": {
    "document": {
      "id": "<string>",
      "document_number": "<string>",
      "note": "<string>",
      "status": "submitted",
      "title": "<string>",
      "file_url": "<string>",
      "verification_type": "automatic",
      "is_verified": true,
      "verified_at": "2023-11-07T05:31:56Z",
      "created_by": "customer",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_by": "customer",
      "modified_at": "2023-11-07T05:31:56Z",
      "modified_reason": "<string>",
      "expires_at": "2023-11-07T05:31:56Z"
    }
  }
}

Path Parameters

id
string
required

customer id

Body

multipart/form-data
document_number
string
required
kyc_document_id
string
required
note
string
file
file

file attachment will be required or optional as per store setting.

Response

200
application/json
OK
message
string
success
boolean
content
object