DKBSignDocs

Get started

Quickstart

Get a company-user token and call the gateway. You only need this API — not the internal services behind it.

Base URL

All requests go to the public gateway origin:

text
https://api.dkbsigns.com

1. Login

Exchange a company admin or employee password for a Sanctum token. Other roles receive 403.

curl
curl -X POST 'https://api.dkbsigns.com/api/v1/login' \
  -H 'Content-Type: application/json' \
  -d '{"email":"user@acme.test","password":"secret"}'

A successful response looks like this:

json
{
  "status": "success",
  "message": "Logged in successfully",
  "data": {
    "user": { "id": 4, "role": "user", "email": "user@acme.test" },
    "access_token": "1|abcdefghijklmnopqrstuvwxyz",
    "mfa_setup_required": false
  }
}

If the account has MFA enrolled, you receive a challenge_token instead of access_token. Complete it with POST /api/v1/login/mfa/verify — see Authentication.

2. Call an endpoint

Send the token on every authenticated request. Path parameters live in the URL. JSON bodies use Content-Type: application/json; file uploads use multipart.

bash
curl 'https://api.dkbsigns.com/api/v1/colleagues' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Accept: application/json'

Next steps