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

StatusMeaningOperations
400Bad request84
401Authentication required136
403Forbidden136
404Not found105
409Conflict84
422Validation error84
429Rate limit exceeded135
500Internal server error135

Error Schema

Field Required Type Flags Constraints Description Example
message yes string "The request could not be processed."
error yes string "BAD_REQUEST"