POST /api/v2/engage_login SYSTEM INTERNAL
Login

Learn how to use Suran API on the Suran Help Center.

Headers

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

Params

Param name Description
username
optional

Username for individual you want to log in

Validations:

  • Must be a String
password
optional

Password for individual you want to log in

Validations:

  • Must be a String
phone_number
optional

Phone number of user if logging in from sms link

Validations:

  • Must be a String
web_token
optional

Web token used to authenticate automatically

Validations:

  • Must be a String
giver_id
optional

ID of individual user is administering their giving

Validations:

  • Must be a String
token
optional

Hashed login token

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
422 Provision/PIN missing
422 Provision/PIN incorrect
422 Provision does not exist
500 No connection to data source