Skip to main content

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:

Parameter Type Description
environment Environment The API environment.
Default: Environment.PRODUCTION
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 30
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
bearer_auth_credentials BearerAuthCredentials The credential object for OAuth 2 Bearer token

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

Name Description
PRODUCTION Default Production server (versioned)
ENVIRONMENT2 Sandbox server (for testing and development, versioned)

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for sc-apimatic-sdk 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sc-apimatic-sdk 0.0.1
File Size Uploaded Provenance Actions
sc_apimatic_sdk-0.0.1.tar.gz 87.6 kB Without provenance Details for sc_apimatic_sdk-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sc-apimatic-sdk 0.0.1
File Interpreter ABI Platform Actions
sc_apimatic_sdk-0.0.1-py3-none-any.whl Python 3 none any Details for sc_apimatic_sdk-0.0.1-py3-none-any.whl

Total release size: 294.0 kB

Release files / sc_apimatic_sdk-0.0.1.tar.gz

Download URL sc_apimatic_sdk-0.0.1.tar.gz
Size 87.6 kB
Tags Source
SHA-256 checksum
How to use checksums
84cbf77134574f7e294e5d60891913b187b9a77fdc3071e7e69f25058bb67e5e
BLAKE2b-256 checksum
How to use checksums
1d30be435a53685944c0d09638ea5c82b048061abb8d10f5929e082a24f628cf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / sc_apimatic_sdk-0.0.1-py3-none-any.whl

Download URL sc_apimatic_sdk-0.0.1-py3-none-any.whl
Size 206.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
20ede89005ad1c8e9577af9d27901d8e4a7ac3625029d7f0cd770c08a18d341a
BLAKE2b-256 checksum
How to use checksums
7c91ff6d331d7292acd010216557c7f92152ff334c43c03e9d59dc551b9e48b1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for sc-apimatic-sdk 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page