Authentication

Request Header

To make an authenticated request you must send the Authorization header with the api token.

Authorization: Bearer api-token-here

API Reference

Retrieve an access token

HTTP Method Endpoint
POST /v1/authenticate

Submit a claim through Contract Modeling

HTTP Method Endpoint
POST /v1/claims

Error Glossary

Invalid credentials

HTTP Code 401 Error Code 12

Invalid username/password were submitted.

{
    "errors": {
        "message": "invalid_credentials",
        "code": 12
    }
}

Missing Token

HTTP Code 401 Error Code 13

The request did not include the API token.

{
    "errors": {
        "message": "missing_token",
        "code": 13
    }
}

Unauthorized

HTTP Code 401 Error Code 14

An invalid API token was submitted.

{
    "errors": {
        "message": "unauthorized",
        "code": 14
    }
}

Token Expired

HTTP Code 401 Error Code 15

The API token has expired, resubmit the user credentials to generate a new API token.

{
    "errors": {
        "message": "token_expired",
        "code": 15
    }
}

Resource not found

HTTP Code 404 Error Code 22

The requested endpoint was not found.

{
    "errors": {
        "message": "resource_not_found",
        "code": 22
    }
}

Validation failed

HTTP Code 422 Error Code 32

The submitted payload failed validation.

{
    "errors": {
        "message": "validation_failed",
        "code": 32,
        "data": {
            "param1": [
                "messages"
            ],
            "param2": [
                "messages"
            ]
        }
    }
}