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 your gateway origin. Local Docker publishes the API at http://localhost:8090. In production, use the public APP_URL of the gateway (scheme + host + port).
text
https://api.dkbsigns.com1. 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
{
"message": "Logged in successfully",
"data": {
"user": { "id": 4, "role": "user", "email": "user@acme.test" },
"access_token": "1|abcdefghijklmnopqrstuvwxyz"
}
}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
- Read Authentication for MFA, social login, and the role gate.
- Create an envelope with POST /api/v4/envelopes.
- Start a workflow with POST /api/workflows/create.
- Handle errors and async jobs.