Offering Manager API

Create an identity document for the kyc verification

POST /users/{user_id}/kyc/identities/{identity_id}/kyc_verification/identity_document

Create an identity document for the kyc verification.

Path parameters

  • user_id string Required

    User id

  • identity_id string Required

    Identity or Legal representative id

Body Required

Identity document information

  • identity_document object
    Hide identity_document attributes Show identity_document attributes object
    • country string
    • document_type string
    • issue_date string(date)
    • issued_by string
    • nationality string
    • number string
    • valid_until string(date)

Responses

  • 201

    Identity document created and returned

    Hide response attributes Show response attributes object
    • id string(uuid)
    • kyc_verification_id string(uuid)
    • country string
    • document_type string
    • issue_date string(date)
    • issued_by string
    • nationality string
    • number string
    • valid_until string(date)
    • created_at string(datetime)
    • updated_at string(datetime)
  • 401

    Authorization information is missing or invalid.

  • 422

    Request body has errors or invalid.

POST /users/{user_id}/kyc/identities/{identity_id}/kyc_verification/identity_document 
curl \
 -X POST https://client-subdomain.bitbond.net/api/v1/users/{user_id}/kyc/identities/{identity_id}/kyc_verification/identity_document \
 -H "Content-Type: application/json" \
 -d '{"identity_document":{"country":"string","document_type":"string","issue_date":"2023-05-04","issued_by":"string","nationality":"string","number":"string","valid_until":"2023-05-04"}}'
Request example 
{
  "identity_document": {
    "country": "string",
    "document_type": "string",
    "issue_date": "2023-05-04",
    "issued_by": "string",
    "nationality": "string",
    "number": "string",
    "valid_until": "2023-05-04"
  }
}
Request examples 
{
  "identity_document": {
    "country": "string",
    "document_type": "string",
    "issue_date": "2025-05-04",
    "issued_by": "string",
    "nationality": "string",
    "number": "string",
    "valid_until": "2025-05-04"
  }
}
Response examples (201) 
{
  "id": "string",
  "kyc_verification_id": "string",
  "country": "string",
  "document_type": "string",
  "issue_date": "2023-05-04",
  "issued_by": "string",
  "nationality": "string",
  "number": "string",
  "valid_until": "2023-05-04",
  "created_at": "string",
  "updated_at": "string"
}
Response examples (201) 
{
  "id": "string",
  "kyc_verification_id": "string",
  "country": "string",
  "document_type": "string",
  "issue_date": "2025-05-04",
  "issued_by": "string",
  "nationality": "string",
  "number": "string",
  "valid_until": "2025-05-04",
  "created_at": "string",
  "updated_at": "string"
}