Getting Started with Socure RiskOS™ API

Introduction

RiskOS™ documentation site is Socure confidential and proprietary information, and is only intended for viewing by authorized persons.

The Socure RiskOS™ APIs provide a unified API framework for risk evaluation. They use predictable, resource-oriented URLs, accept JSON-formatted request bodies, return JSON-formatted responses, and follow standard HTTP methods, status codes, and authentication practices.

You can test RiskOS™ APIs in the Sandbox environment, which allows you to simulate requests without impacting live data. The request endpoint determines whether the request is directed to the Sandbox or Production (live) environment.

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install sc-apimatic-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/sc-apimatic-sdk/0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from socureriskosapi.configuration import Environment
from socureriskosapi.http.auth.oauth_2 import BearerAuthCredentials
from socureriskosapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from socureriskosapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from socureriskosapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from socureriskosapi.socureriskosapi_client import SocureriskosapiClient

client = SocureriskosapiClient(
    bearer_auth_credentials=BearerAuthCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from socureriskosapi.socureriskosapi_client import SocureriskosapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = SocureriskosapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Authorization

This API uses the following authentication schemes.

• BearerAuth (OAuth 2 Bearer token)

List of APIs

• Reason Codes
• Evaluation
• Feedback

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime