Skip to main content

Authenticate User

POST 
/authenticate

Authenticates a user account using login details and returns a temporary `x-access-token` header (valid for 6 hours) that can be used with this API.

Only users that have been given API access are able to authenticate successfully. If you create a new user account and wish to use it, let us know so we can enable it.

Request​

Header Parameters

    x-force-status integer

    An integration test header to skip normal execution and force a particular HTTP status response (ie 200, 400, 404, 500). Can be used in ALL entry points even if not explicitly mentioned.

    Example: 500

Body

required

Authentication info

    email stringrequired

    The email for this user

    password stringrequired

    The password for this user

Responses​

OK

Schema
    user_uid stringrequired

    A unique identifier for this user.

    x-access-token stringrequired

    A token for loging in to the API using the x-access-token header. Expires after 6 hours.

    has_payment_method booleanrequired

    If the user has a valid payment method

Loading...