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
Email address.
320
"example@email.com"
Identifier for entry point originating the request (used by front-end apps)
"test"
Type of entry identifier: 0 - partner, 2 - paypoint
used by front-end apps, required if an Entry is indicated.
2
Response
Response text for operation: 'Success' or 'Declined'.
"Success"
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
true
Data returned by the response, masked for security.
"g**.com"
When true
, multi-factor authentication (MFA) is enabled.
false
The mode of multi-factor authentication used.
"email"
The validation code for multi-factor authentication, typically a hash or similar encrypted format.
"50-2E-4A-16-93-0E-41-41-07-EE-22-B6-00-99-00-99"
Was this page helpful?