# SmartID • Start

Use this endpoint to start signing with SmartID of PrivatBank. Our system returns `confirmation_url`. Show it to the applicant, then call [SmartID • Get status](#operation/qes-smartid-get-status) to get the result.

Endpoint: POST /services/ua/smartid/start
Version: 1.0
Security: API-Key

## Security:

  - `API-Key` (unknown)
    apiKey in header API-Key

## Request fields (application/json):

  - `verification_id` (string, required)
    ID of the verification with documents to sign
    Example: 9a8b7c6d5e4f30211203f4e5d6c7b8a90123

## Response 200:

  - `200` (unknown)
    **OK**
The request was processed. Check the `status` field.
- `need_sign` — the link is ready. Show `confirmation_url` to the applicant.
- `forbidden` — the verification has no documents to sign.
- `error` — our system could not prepare the link. Try again later.

## Response 200 fields (application/json):

  - `status` (string)
    Enum: "need_sign", "forbidden", "error"

  - `data` (object)

  - `data.verification_id` (string)
    Example: 9a8b7c6d5e4f30211203f4e5d6c7b8a90123

  - `data.confirmation_url` (string)
    SmartID URL. Our system returns it only when `status` is `need_sign`
    Example: https://smartid.example.com/sign/00000000

## Response 403:

  - `403` (unknown)
    **Forbidden**

## Response 403 fields (application/json):

  - `status` (string)
    Example: forbidden

  - `data` (object)

  - `data.verification_id` (string)
    Example: 9a8b7c6d5e4f30211203f4e5d6c7b8a90123

## Response 404:

  - `404` (unknown)
    **Not Found**

## Response 404 fields (application/json):

  - `type` (string)
    Example: not_found

  - `errors` (array)

  - `errors.parameter` (string)
    Example: verification_id

  - `errors.message` (string)
    Example: The verification was not found

  - `data` (object)

  - `data.verification_id` (string)
    Example: 9a8b7c6d5e4f30211203f4e5d6c7b8a90123

## Response 422:

  - `422` (unknown)
    **Unprocessable Entity**

## Response 422 fields (application/json):

  - `type` (string)
    Example: validation

  - `errors` (array)

  - `errors.parameter` (string)
    Example: verification_id

  - `errors.message` (string)
    Example: Verification ID is not valid

## Response 500:

  - `500` (unknown)
    **Internal Server Error**
This response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request.

## Response 500 fields (application/json):

  - `type` (string)
    Example: internal_server

  - `errors` (array)