---
title: "Hash and verify passwords with bcrypt."
method: POST
path: "/api/v1/bcrypt"
tags: ["Cryptography & Hashing"]
---

# Hash and verify passwords with bcrypt.

`POST /api/v1/bcrypt`

## Request

- Base URL: `https://programmes.net`
- URL: `https://programmes.net/api/v1/bcrypt`
- Auth: none declared

Bcrypt Generator & Verifier. Operations: `hash` — Hash a password with bcrypt at the given cost. `verify` — Verify a plaintext password against a bcrypt hash.

## Request body

- union
  - BcryptHash: Hash a password with bcrypt at the given cost.
    - `operation` 'hash', required
    - `input` string: The plaintext password to hash.
    - `options` object
      - `rounds` integer: Cost factor (log2 of the rounds). The API runs cost 4 to 4; higher costs run in the browser at /tools/bcrypt.
  - BcryptVerify: Verify a plaintext password against a bcrypt hash.
    - `operation` 'verify', required
    - `input` string: The plaintext password to check.
    - `options` object, required
      - `hash` string, required: The bcrypt hash to compare against (cost 4 or lower over the API).

## Response `200`

The operation ran.

- object
  - `ok` unknown, required
  - `tool` 'bcrypt', required
  - `operation` 'hash' | 'verify', required
  - `result` unknown, required

## Other responses

- `400`: The request is not valid (https://programmes.net/api#invalid-request); The tool has no such operation (https://programmes.net/api#unknown-operation)
- `404`: No such tool (https://programmes.net/api#unknown-tool)
- `413`: The request or its input is too large (https://programmes.net/api#content-too-large)
- `415`: The body must be JSON (https://programmes.net/api#unsupported-media-type)
- `422`: An option is missing, of the wrong type or out of range (https://programmes.net/api#invalid-options); This call needs more CPU than one API call may use (https://programmes.net/api#refused); The operation could not process the input (https://programmes.net/api#tool-error)
- `429`: Too many requests (https://programmes.net/api#rate-limited)
- `500`: Internal error (https://programmes.net/api#internal-error)

---

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