User

Authenticate User

This endpoint requires an application API token.

post/User/auth/{provider}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/User/auth/{provider}
  • Auth: HTTP bearer

Path parameters

providerstring required

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

Request body

emailstring email

Email address.

entrystring

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

entryTypeinteger

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

pswstring
userIdinteger
userTokenIdstring

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 required

Response text for operation: 'Success' or 'Declined'.

Changes

No recorded changes to this operation across all 1 revision of this API.