Authenticate user

This endpoint requires an application API token.

Authentication

requestTokenstring

API Key authentication via header

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’.

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.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error

API Key authentication via header

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

This endpoint expects an object.

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

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

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

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.

$	curl -X POST https://api-sandbox.payabli.com/api/User/auth/provider \
>	-H "requestToken: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"responseText": "Success",
3	"isSuccess": true,
4	"mfa": false,
5	"mfaMode": "email",
6	"mfaValidationCode": "50-2E-4A-16-93-0E-41-41-07-EE-22-B6-00-99-00-99",
7	"responseData": "g**.com"
8	}

$	curl -X POST https://api-sandbox.payabli.com/api/User/auth/provider \
>	-H "requestToken: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"responseText": "Success",
3	"isSuccess": true,
4	"mfa": false,
5	"mfaMode": "email",
6	"mfaValidationCode": "50-2E-4A-16-93-0E-41-41-07-EE-22-B6-00-99-00-99",
7	"responseData": "g**.com"
8	}