Authenticate User Access

Logs a user in

curl --request POST \
  --url https://api.creditriskmonitor.com/v1/Users/Login \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'Username=<string>' \
  --data 'Password=<string>' \
  --data 'LinkBasedMFA=<string>' \
  --data 'Key=<string>'

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

POST

Users

Logs a user in

curl --request POST \
  --url https://api.creditriskmonitor.com/v1/Users/Login \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'Username=<string>' \
  --data 'Password=<string>' \
  --data 'LinkBasedMFA=<string>' \
  --data 'Key=<string>'

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

You must call this endpoint first to retrieve the SessionKey before interacting with other endpoints.

Body

application/x-www-form-urlencoded

Username

string

required

Password

string<password>

required

LinkBasedMFA

string

Key

string

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

Retrieve SIC Industry News Get Logged User Info

⌘I

Overview

Business Information

Financial Data

Portfolio Management

News Management

User Management

Trade Receivables

Body

Response