---
title: "Choose number"
method: POST
path: "/v1/onboarding/number"
tags: ["Owner"]
---

# Choose number

`POST /v1/onboarding/number`

## Request

- Base URL: `https://api.vicem.ai`
- URL: `https://api.vicem.ai/v1/onboarding/number`
- Auth: HTTP bearer

## Request body

- union
  - object
    - `mode` 'provision', required
    - `country` string, required
    - `areaCode` string
    - `interim` union
      - object
        - `country` string, required
      - 'none'
    - `exactCountry` boolean
  - object
    - `mode` 'forward', required
    - `ownerNumber` string, required
    - `country` string
    - `interim` union
      - object
        - `country` string, required
      - 'none'
    - `usNumber` boolean
  - object
    - `mode` 'byoc', required
    - `carrierName` string, required

## Response `200`

OK

- NumberChoiceRes
  - `vicemNumber` string, required
  - `status` 'active' | 'pending' | 'documents', required
  - `kycCountry` string
  - `interimCountry` string
  - `interimFailed` boolean
  - `forwardingInstructions` object, nullable, required
    - `carrierHint` string, nullable, required
    - `enableCode` string, required
    - `disableCode` string, required
    - `verifyBy` string, required
    - `ownerCountry` string

## Other responses

- `400`: Invalid request (body not JSON, or schema validation failed).
- `401`: Missing, expired or invalid bearer token.
- `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)