Validate Two-Factor Authentication

Accepts a Two Factor Authentication Key

curl --request POST \
  --url https://api.creditriskmonitor.com/v1/Users/2FAKey \
  --header 'Authorization: Bearer <token>'

{
  "Success": true,
  "Data": {
    "SessionKey": "<string>",
    "Username": "<string>",
    "SessionId": 123,
    "TwoFactorAuthenticationRequired": true,
    "Key": "<string>"
  },
  "ErrorCode": "<string>"
}

POST

Users

2FAKey

Accepts a Two Factor Authentication Key

curl --request POST \
  --url https://api.creditriskmonitor.com/v1/Users/2FAKey \
  --header 'Authorization: Bearer <token>'

{
  "Success": true,
  "Data": {
    "SessionKey": "<string>",
    "Username": "<string>",
    "SessionId": 123,
    "TwoFactorAuthenticationRequired": true,
    "Key": "<string>"
  },
  "ErrorCode": "<string>"
}

Use the Login endpoint to retrieve the SessionKey, then include it in the Authorization field for authentication.

Authorizations

Authorization

string

header

required

Enter the Session Key with the Bearer prefix, e.g. "Bearer abcde12345".

Query Parameters

Key

string

required

The One Time Password that was sent to the users phone.

Response

Success

boolean

Data

object

Show child attributes

Data.SessionKey

string

The Session Key for the user. This Session Key must be sent in the header of all subsequent calls.

Data.Username

string

Username for the logged in user.

Data.SessionId

integer<int32>

Session Id

Data.TwoFactorAuthenticationRequired

boolean

True when Two Factor Authentication is required for this login. A One Time Password will be sent to the phone number on record for the user account. Make a subsiquent request to the /v1/Users/2FAKey endpoint with the One Time Password to complete Two Factor Authentication.

Data.Key

string

When the User account is setup for Device/Browser verification this field will contain a value. Send this value with subsequent requests to /v1/Users/LoginBrowser to remember 2FA verification requests.

ErrorCode

string

Get Logged User Info List Trade Providers

⌘I

Overview

Business Information

Financial Data

Portfolio Management

News Management

User Management

Trade Receivables

Validate Two-Factor Authentication

Authorizations

Query Parameters

Response