monitoring-api.accurate.com Open in urlscan Pro
34.238.59.34  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Body
 * Headers (0)

 * Body
 * Headers (0)

 * Body
 * Headers (0)

 * Body
 * Headers (0)




Public


Documentation Settings

ENVIRONMENT
Accurate Background

LAYOUT
Double Column

LANGUAGE
cURL - cURL



Continuous Criminal Monitoring API
Introduction
Authentication
Integration


CONTINUOUS CRIMINAL MONITORING API

API Documentation to integrate with Accurate Background's Continuous Criminal
Monitoring API.


AUTHENTICATION




POSTGENERATE BEARER TOKEN

https://monitoring.accurate.com/token


DESCRIPTION

In order to access the APIs, you need to first request a bearer token from the
API using your credentials.


SAMPLE C#:

View More
Plain Text


var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://monitoring.accurate.com/token"),
    Content = new FormUrlEncodedContent(new Dictionary<string, string>
    {
        { "grant_type", "password" },
        { "username", "user@email.com" },
        { "password", "pwABC123!" },
    }),
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}


ACCESSING PROTECTED APIS:

   
 * Now that you have a bearer token, you can access protected APIs by including
   the access token in the authorization header of the subsequent requests:
   

Plain Text


"token": "{access token}",
"prefix": "bearer"


SAMPLE C# USING AUTHENTICATION:

View More
Plain Text


var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://monitoring.accurate.com/api/IntegrationApi/GetCompanyProfiles"),
    Headers =
    {
        { "authorization", "bearer abc-123tokentokentoken" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Bodyurlencoded
grant_type

password

username

admin@email.com

password

pwABC123!

Example Request
Generate Bearer Token - Invalid Credentials

curl


curl --location 'https://monitoring.accurate.com/token' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'username=admin@email.com' \
--data-urlencode 'password=pwABC123'

Example Response
 * Body
 * Headers (0)

Text


{
  "error": "invalid_grant",
  "error_description": "The user name or password is incorrect."
}

No response headers
This request doesn't return any response headers


POSTGENERATE REFRESH TOKEN

https://monitoring.accurate.com/token


GENERATING A BEARER TOKEN USING THE REFRESH TOKEN:

   
 * The bearer token that you received from the API server will expire after 20
   minutes. After the token expires you need to obtain a refresh token to
   continue sending requests to Monitoring API. The benefit of using a refresh
   token request to generate a new bearer token is that you do not have to send
   your credentials to the server anymore in order to receive the new token.
   
 * To receive a refresh token, send a HTTP POST Request
   to https://monitoring.accurate.com/token endpoint and include the following
   data in the request content:
   


SAMPLE C# REFRESH TOKEN:

View More
Plain Text


var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://monitoring.accurate.com/token"),
    Content = new FormUrlEncodedContent(new Dictionary<string, string>
    {
        { "grant_type", "refresh_token" },
        { "refresh_token", "def-456refreshtokenrefreshtokenrefreshtoken" },
    }),
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Bodyurlencoded
grant_type

refresh_token

refresh_token

{refresh_token_obtained_via_generate_bearer_token}

Example Request
Generate Refresh Token - Invalid Refresh Token

curl


curl --location 'https://monitoring.accurate.com/token' \
--data-urlencode 'grant_type=refresh_token' \
--data-urlencode 'refresh_token=piQlG-DHlUFvQFcrUc3sd_oplIi86vzaQ3TZLy9vF9gaHI-O'

Example Response
 * Body
 * Headers (0)

Text


{
  "error": "invalid_grant"
}

No response headers
This request doesn't return any response headers
INTEGRATION

Examples for each Integration request can be viewed by selecting the example via
the dropdown.




POSTADDMONITORINGORDERS


https://monitoring.accurate.com/api/IntegrationApi/AddMonitoringOrders


DESCRIPTION

Adds new monitoring orders for the people and profile provided in the request.
The Monitoring system will not create multiple orders for the same person and
the same profile if it finds duplicate people in the request or if a monitoring
order already exists for a person and a profile that was sent in the request. If
an invalid company or a company you do not have access to is provided, the
monitoring order will not be created and a request error will be returned. In
order to identify duplicate people, monitoring system uses the unique identifier
fields that were defined in the Monitoring Application -> Bulk Import -> Order
Settings.


ADDITIONAL NOTES

   
 * Orders that already exist will be ignored. To verify if an order already
   exists, search for the order in the Monitoring Application -> Monitoring
   Orders -> Monitoring Orders List
   (https://monitoring.accurate.com/#/monitoringOrdersList).
   
 * A maximum of 100 people can be sent in each request.
   


RESPONSE


200 : SUCCESS

The response payload is a json object with the following properties:

   
 * orderStatuses: This is a json object with 3 properties:
     
   * uniqueIdentifiers: The uniqueIdentifiers property is a json object that
     contains the unique identifier fields for a person.
     
   * status: The status property is a string that contains the status of the
     order and can have any of the following values:
       
     * Success - The order was added successfully.
       
     * Error - One of the fields contained in the order was invalid or missing.
       
     * Duplicate - The order already exists in the system or was submitted more
       than once in the request.
       
     
   * message: The message property contains extra information about the order
     status or request, if necessary.
     
   


401: AUTHORIZATION DENIED

If a company that user does not have access was provided in the request or the
bearer token is invalid or expired the response payload is a json object with
one property:

   
 * message
   


400: REQUEST ERROR

If an invalid or excluded profile was provided in the request or request was not
valid, the response payload is a json object with one property:

   
 * message
   

AUTHORIZATIONBearer Token
Token

{{bearer_token}}

Bodyraw (json)
View More
json


{
  "CompanyName": "Company",
  "ProfileName": "Profile A",
  "People": [
    {
      "FirstName": "John",
      "MiddleName": "M",
      "LastName": "Doe",
      "Suffix": "",
      "Ssn": "123-12-1234",
      "Birthdate": "2001-01-01",
      "WorkState": null,
      "WorkCity": null,
      "WorkPosition": null,
      "WorkLocation": null,
      "WorkDivision": null,
      "Company": null,
      "Address": null,
      "State": null,
      "City": null,
      "ZipCode": null,
      "DL_Number": null,
      "ReferenceId": null,
      "AliasFirstName": "",
      "AliasMiddleName": "",
      "AliasLastName": ""
    }
  ]
}

Example Request
AddMonitoringOrders - Single Order

View More
curl


curl --location 'https://monitoring.accurate.com/api/IntegrationApi/AddMonitoringOrders' \
--data '{
    "CompanyName": "Company",
    "ProfileName": "Profile A",
    "People": [
        {
            "FirstName": "John",
            "MiddleName": "M",
            "LastName": "Doe",
            "Suffix": "",
            "Ssn": "123-12-1234",
            "Birthdate": "2001-01-01T00:00:00",
            "WorkState": null,
            "WorkCity": null,
            "WorkPosition": null,
            "WorkLocation": null,
            "WorkDivision": null,
            "Company": null,
            "Address": null,
            "State": null,
            "City": null,
            "ZipCode": null,
            "DL_Number": null,
            "ReferenceId": null,
            "AliasFirstName": null,
            "AliasMiddleName": null,
            "AliasLastName": null
        }
    ]
}'

Example Response
 * Body
 * Headers (0)

View More
Text


{
  "orderStatuses": [
    {
      "uniqueIdentifiers": {
        "firstName": "John",
        "lastName": "Doe",
        "birthDate": "2001-01-01T00:00:00Z",
        "ssn": "XXX-XX-1234"
      },
      "status": "Success"
    }
  ]
}

No response headers
This request doesn't return any response headers


POSTUPDATEMONITORINGORDERS


https://monitoring.accurate.com/api/IntegrationApi/UpdateMonitoringOrders


DESCRIPTION

Updates existing monitoring orders for the people provided in the request. If an
invalid company or a company you do not have access to is provided, the
monitoring order will not be updated and a request error will be returned. In
order to identify the people in the request, the monitoring system uses the
unique identifier fields that were defined in the Monitoring Application -> Bulk
Import -> Order Settings.


ADDITIONAL NOTES

   
 * Omitting a field (by providing null or "") will erase the existing value of
   that field.
   
 * The unique identifier fields (or fields that are used to identify duplicate
   people) can be changed in the Monitoring Application -> Bulk Import -> Order
   Settings (https://monitoring.accurate.com/#/import/settings).
   
 * A maximum of 100 people can be sent in each request.
   


RESPONSE


200 : SUCCESS

The response payload is a json object with the following properties:

   
 * orderStatuses: This is a json object with 3 properties:
     
   * uniqueIdentifiers: The uniqueIdentifiers property is a json object that
     contains the unique identifier fields for a person.
     
   * status: The status property is a string that contains the status of the
     order and can have any of the following values:
       
     * Success - The order was added successfully.
       
     * Error - One of the fields contained in the order was invalid or missing.
       
     * Duplicate - The order was submitted more than once in the request.
       
     
   * message: The message property contains extra information about the order
     status or request, if necessary.
     
   


401: AUTHORIZATION DENIED

If a company that user does not have access was provided in the request or the
bearer token is invalid or expired the response payload is a json object with
one property:

   
 * message
   


400: REQUEST ERROR

If an invalid or excluded profile was provided in the request or request was not
valid, the response payload is a json object with one property:

   
 * message
   

AUTHORIZATIONBearer Token
Token

{{bearer_token}}

Bodyraw (json)
View More
json


{
	"CompanyName": "Company",
	"People": [
	{
      "FirstName": "John",
      "MiddleName": "M",
      "LastName": "Doe",
      "Suffix": "",
      "Ssn": "123-12-1234",
      "Birthdate": "2001-01-01",
      "WorkState": null,
      "WorkCity": null,
      "WorkPosition": null,
      "WorkLocation": null,
      "WorkDivision": null,
      "Company": null,
      "Address": null,
      "State": null,
      "City": null,
      "ZipCode": null,
      "DL_Number": null,
      "ReferenceId": null,
      "AliasFirstName": "",
      "AliasMiddleName": "",
      "AliasLastName": ""
	}
	]
}

Example Request
UpdateMonitoringOrders - Single Order

View More
curl


curl --location 'https://monitoring.accurate.com/api/IntegrationApi/UpdateMonitoringOrders' \
--data '{
    "CompanyName": "Company ABC",
    "People": [
        {
            "FirstName": "John",
            "MiddleName": "M",
            "LastName": "Doe",
            "Suffix": "",
            "Ssn": "123-12-1234",
            "Birthdate": "2001-01-01",
            "City": "Los Angeles"
        },
    ]
}'

Example Response
 * Body
 * Headers (0)

View More
Text


{
  "orderStatuses": [
    {
      "uniqueIdentifiers": {
        "firstName": "John",
        "lastName": "Doe",
        "birthDate": "2001-01-01T00:00:00Z",
        "ssn": "XXX-XX-1234"
      },
      "status": "Success"
    }
  ]
}

No response headers
This request doesn't return any response headers