Offering Manager API

Add a file attachment to the identity

POST /users/{user_id}/kyc/identities/{id}/file/{type}/{number}

Add a file attachment to the identity.

Path parameters

user_id string Required

User id
id string Required

Resource ID
type string Required

File type

Values are commercial_register, authorization, or legal_structure.
number string Required

Document ID number

Query parameters

issued_at string Required

Document issued at date
expires_at string Required

Document expires at date
issuing_authority string Required

Document issuing authority
issuing_country string Required

Document issuing country

application/json

Body Required

The identity file information

attachment object Required

Responses

• 201

File attachment created and returned
Hide response attributes Show response attributes object
- id string(uuid)
- file object
- filename string
- document_type string
- document_id_number string
- issued_at string(datetime)
- expires_at string(datetime)
- issuing_authority string
- issuing_country string
- content_type string
• 401

Authorization information is missing or invalid.
• 422

Request body has errors or invalid.

POST /users/{user_id}/kyc/identities/{id}/file/{type}/{number}

curl \
 -X POST https://client-subdomain.bitbond.net/api/v1/users/{user_id}/kyc/identities/{id}/file/{type}/{number}?issued_at=string&expires_at=string&issuing_authority=string&issuing_country=string \
 -H "Content-Type: application/json" \
 -d '{"attachment":{}}'

Request example

{
  "attachment": {}
}

Response examples (201)

{
  "id": "string",
  "file": {},
  "filename": "string",
  "document_type": "string",
  "document_id_number": "string",
  "issued_at": "string",
  "expires_at": "string",
  "issuing_authority": "string",
  "issuing_country": "string",
  "content_type": "string"
}