API referencePay Ops endpointsUser management

Authenticate user

This endpoint requires an application API token.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

providerstringRequired

Auth provider. Optional By default is null for 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
used by front-end apps, required if an Entry is indicated.

pswstringOptional
userIdlongOptional
userTokenIdstringOptional

Response

Success
isSuccessboolean

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

mfaboolean

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

mfaModestring

The mode of multi-factor authentication used.

mfaValidationCodestring

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

responseDatastring
Data returned by the response, masked for security.
responseTextstring

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

Errors

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