Security and Errors
Authentication, reusable error responses, and documented error status coverage for API v2.
Security Schemes
{
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "Sanctum token",
"description": "Laravel Sanctum bearer token returned by the authentication endpoint."
}
}
Reusable Responses
AcceptanceCreateBadRequest
AcceptanceCreateConflict
AcceptanceCreateValidationError
BadRequest
Conflict
CrossDockBadRequest
CrossDockConflict
CrossDockForbidden
CrossDockInternalServerError
CrossDockNotFound
CrossDockTooManyRequests
CrossDockUnauthorized
CrossDockValidationError
Forbidden
InternalServerError
NotFound
SendDocumentConflict
TooManyRequests
Unauthorized
ValidationError
Error Coverage
| Status | Meaning | Operations |
400 | Bad request | 84 |
401 | Authentication required | 136 |
403 | Forbidden | 136 |
404 | Not found | 105 |
409 | Conflict | 84 |
422 | Validation error | 84 |
429 | Rate limit exceeded | 135 |
500 | Internal server error | 135 |
Error Schema
| Field |
Required |
Type |
Flags |
Constraints |
Description |
Example |
message |
yes |
string |
|
|
|
"The request could not be processed." |
error |
yes |
string |
|
|
|
"BAD_REQUEST" |