Authenticate user

View as MarkdownOpen in Claude
This endpoint requires an application API token.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Path parameters

providerstringRequired

Auth provider. Pass null to use the built-in provider.

Request

This endpoint expects an object.
emailstringOptionalformat: "email"<=320 characters
Email address.
entrystringOptional

Identifier for entry point originating the request (used by front-end apps)

entryTypeintegerOptional

Type of entry identifier: 0 - partner, 2 - paypoint. This is used by front-end apps, required if an Entry is indicated.

pswstringOptional
userIdlongOptional
userTokenIdstringOptional

Response

Success
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

isSuccessbooleanOptional

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

mfabooleanOptional

When true, multi-factor authentication (MFA) is enabled.

mfaModestringOptional

The mode of multi-factor authentication used.

mfaValidationCodestringOptional

The validation code for multi-factor authentication, typically a hash or similar encrypted format.

responseDatastringOptional
Data returned by the response, masked for security.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error