Headers

Header name Description
Provision
required
Web/Mobile/API Provision UUID

Params

Param name Description
phone_number
optional

Phone number for individual

Validations:

  • Must be a String

Returns

Code: 401

Description:

Unauthorized

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements

errors[error]
required

Why the request failed

Validations:

  • Must be a String

errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 404

Description:

Not Found

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements

errors[error]
required

Why the request failed

Validations:

  • Must be a String

errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 422

Description:

Unprocessable Entity

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements

errors[error]
required

Why the request failed

Validations:

  • Must be a String

errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 500

Description:

Internal Server Error

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements

errors[error]
required

Why the request failed

Validations:

  • Must be a String

errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Errors

Code Description
404 Data source query failed
422 Invalid parameter(s)
422 Provision header missing
422 Invalid provision
422 Under maintenance
422 Incorrect host for provision
422 Establishing session failed
422 Privilege to perform the action was not found
500 No connection to data source