---
title: "Kyc upload"
method: POST
path: "/v1/kyc/{country}/documents"
tags: ["Owner"]
---

# Kyc upload

`POST /v1/kyc/{country}/documents`

## Request

- Base URL: `https://api.vicem.ai`
- URL: `https://api.vicem.ai/v1/kyc/{country}/documents`
- Auth: HTTP bearer

## Path parameters

- `country` string, required

## Request body

- union
  - union
    - object
      - `kind` 'id_document' | 'proof_of_address', required
      - `fileBase64` string, required
      - `filename` string, required
    - object
      - `kind` 'address', required
      - `address` object, required
        - `firstName` string, required
        - `lastName` string, required
        - `streetAddress` string, required
        - `extendedAddress` string
        - `locality` string, required
        - `postalCode` string, required
        - `administrativeArea` string
    - object
      - `kind` 'details', required
      - `details` object, required
        - `id_type` 'passport' | 'id_card' | 'driving_license'
        - `id_number` string
        - `id_issuer` string
        - `id_expiry` string
        - `tax_id` string
        - `date_of_birth` string
        - `place_of_birth` string
    - object
      - `kind` 'area', required
      - `area` string, required
    - object
      - `kind` 'form', required
      - `signature` string, required
  - object
    - `fieldId` 'address', required
    - `address` object, required
      - `firstName` string, required
      - `lastName` string, required
      - `streetAddress` string, required
      - `extendedAddress` string
      - `locality` string, required
      - `postalCode` string, required
      - `administrativeArea` string
  - object
    - `fieldId` 'area', required
    - `area` string, required
  - object
    - `fieldId` string, required
    - `signature` string, required
  - object
    - `fieldId` string, required
    - `file` object, required
      - `base64` string, required
      - `filename` string, required
      - `mime` string, required
  - object
    - `fieldId` string, required
    - `value` string, required

## Response `200`

OK

- KycStatusResponse
  - `country` string, required
  - `status` 'none' | 'collecting' | 'pending_kyc' | 'needs_fix' | 'ordered' | 'declined' | 'cancelled', required
  - `missing` string[], required
  - `details` string[], required
  - `idIssuedHere` boolean, required
  - `taxIdName` string, nullable, required
  - `issue` 'id_document' | 'proof_of_address' | 'address' | 'area' | 'details' | 'form' | 'other', nullable, required
  - `form` object, nullable, required
    - `fieldId` string, required
    - `title` string, required
    - `facts` string[], required
    - `paragraphs` string[], required
    - `name` string, required
  - `message` string, nullable, required
  - `number` string, nullable, required
  - `provider` 'telnyx' | 'didww', nullable, required
  - `fields` object[], required
    - `id` string, required
    - `kind` string, required
    - `label` string, required
    - `labelParams` object
      - `name` string, required
    - `required` boolean, required
    - `constraints` object, required
      - `scope` 'worldwide' | 'country' | 'area' | 'city'
      - `issuedIn` 'number_country' | 'any'
      - `maxAgeDays` integer
      - `acceptable` string[]
      - `pattern` string
      - `fileTypes` string[]
      - `maxBytes` integer
    - `done` boolean, required
  - `steps` array[], required
    - string[]
  - `missingFields` string[], required
  - `reviewDays` integer, nullable, required
  - `reviewMaxDays` integer, nullable, required
  - `restrictionNote` string, nullable, required
  - `reviewSince` string, nullable, required
  - `interim` string, nullable, required
  - `replaces` boolean, required

## Other responses

- `400`: Invalid request (body not JSON, or schema validation failed).
- `401`: Missing, expired or invalid bearer token.
- `404`: No such resource, or not visible to this caller.
- `413`: Body over the limit (64 KB; 512 KB for contact import).
- `500`: Unexpected server error (reported to Sentry).

---

[API](https://skmtc.dev/vicem/apis/vicem-api.md) · [All operations](https://skmtc.dev/vicem/apis/vicem-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vicem/apis/vicem-api/revisions/9efcec07e5f4?raw)