Authenticate User
This endpoint requires an application API token.
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
Auth provider. Optional By default is null for the built-in provider
Body
Identifier for entry point originating the request (used by front-end apps)
Type of entry identifier: 0 - partner, 2 - paypoint
used by front-end apps, required if an Entry is indicated.
Response
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
When true
, multi-factor authentication (MFA) is enabled.
The mode of multi-factor authentication used.
The validation code for multi-factor authentication, typically a hash or similar encrypted format.
Data returned by the response, masked for security.
Response text for operation: 'Success' or 'Declined'.
Was this page helpful?