signet-core 1.0.0

Credentials Service API

signet-core

API documentation for the Credentials service - Mandate and Enrollment endpoints

API documentation for the Fraud service - Blacklist, Device, Geo, IP, Reporting, and Risk endpoints

API documentation for the Partner service - Management endpoints

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.19.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import signet_core

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import signet_core

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import signet_core
from signet_core.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = signet_core.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (DPoP): DPoP
configuration = signet_core.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with signet_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = signet_core.BlacklistApi(api_client)
    blacklist_controller_blacklist_client_request = signet_core.BlacklistControllerBlacklistClientRequest() # BlacklistControllerBlacklistClientRequest | Blacklist request with structured risk reasons

    try:
        # Add client to blacklist
        api_instance.blacklist_controller_blacklist_client(blacklist_controller_blacklist_client_request)
    except ApiException as e:
        print("Exception when calling BlacklistApi->blacklist_controller_blacklist_client: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
BlacklistApi	blacklist_controller_blacklist_client	POST /fraud/v1/blacklist	Add client to blacklist
BlacklistApi	blacklist_controller_check_blacklist	GET /fraud/v1/blacklist/client/{clientId}	Check if client is blacklisted
BlacklistApi	blacklist_controller_get_blacklisted_clients	GET /fraud/v1/blacklist/all	Get all blacklisted clients
BlacklistApi	blacklist_controller_remove_blacklist_client	DELETE /fraud/v1/blacklist	Remove client from blacklist
CommsApi	comms_controller_check_client_status	POST /fraud/v1/comms/check-client-status	Check client blacklist and risk status
DeviceApi	device_controller_device_check_for_user	GET /fraud/v1/device/{deviceId}/{userId}	Check if device is flagged for user
DeviceApi	device_controller_flag_device	POST /fraud/v1/device	Flag device
DeviceApi	device_controller_get_flagged_devices	GET /fraud/v1/device/all	Get all flagged devices
DeviceApi	device_controller_unflag_device	DELETE /fraud/v1/device	Remove device flag
EnrollmentApi	enrollment_controller_enroll_user	POST /credentials/v1/enrollment/user	Enroll a user
GeoApi	geo_controller_geo_verify	POST /fraud/v1/geo/verify	Verify geographic location
GeoApi	geo_controller_get_failed_verifications	GET /fraud/v1/geo/failed/{clientId}	Get failed geo verifications
GeoApi	geo_controller_get_successful_verifications	GET /fraud/v1/geo/successful/{clientId}	Get successful geo verifications
IpApi	ip_controller_flag_ip	POST /fraud/v1/ip	Flag IP address
IpApi	ip_controller_get_flagged_ips	GET /fraud/v1/ip/all	Get all flagged IPs
IpApi	ip_controller_ip_check_for_client	GET /fraud/v1/ip/{ip}/{clientId}	Check if IP is flagged for client
IpApi	ip_controller_unflag_ip	DELETE /fraud/v1/ip	Unflag IP address
MandateApi	mandate_controller_create_cart_mandate	POST /credentials/v1/mandate/cart	Create a cart mandate
MandateApi	mandate_controller_create_intent_mandate	POST /credentials/v1/mandate/intent	Create an intent mandate
MandateApi	mandate_controller_create_payment_mandate	POST /credentials/v1/mandate/payment	Create a payment mandate
MandateApi	mandate_controller_create_signed_payment_mandate	POST /credentials/v1/mandate/payment/signed	Create a signed payment mandate
MandateApi	mandate_controller_get_mandate	GET /credentials/v1/mandate	Get mandates
MandateApi	mandate_controller_get_mandate_by_client_id	GET /credentials/v1/mandate/{clientId}	Get mandates by client ID
PartnerApi	management_controller_all_clients	GET /partner/v1/all-clients	Get All Clients
PartnerApi	management_controller_get_client	GET /partner/v1/get-client/{clientId}	Get Client by ID
PartnerApi	management_controller_register_client	POST /partner/v1/register-client	Register Client
PartnerApi	management_controller_remove_client	DELETE /partner/v1/remove-client	Remove Client
PartnerApi	management_controller_update_client	PATCH /partner/v1/update-client	Update Client
ReportingApi	reporting_controller_check_client	GET /fraud/v1/report/{clientId}	Check if client is flagged
ReportingApi	reporting_controller_get_all_reports	GET /fraud/v1/report/all	Get all fraud reports
ReportingApi	reporting_controller_remove_report	DELETE /fraud/v1/report	Remove fraud reports
ReportingApi	reporting_controller_report_client	POST /fraud/v1/report	Report client for fraud

Documentation For Models

• BlacklistControllerBlacklistClientRequest
• BlacklistControllerBlacklistClientRequestReasonsInner
• BlacklistControllerRemoveBlacklistClientRequest
• CommsControllerCheckClientStatusRequest
• DeviceControllerFlagDeviceRequest
• DeviceControllerFlagDeviceRequestReasonsInner
• DeviceControllerUnflagDeviceRequest
• EnrollmentControllerEnrollUser201Response
• EnrollmentControllerEnrollUser201ResponseData
• EnrollmentControllerEnrollUser201ResponseDataMetadata
• EnrollmentControllerEnrollUserRequest
• GeoControllerGeoVerifyRequest
• IpControllerFlagIpRequest
• IpControllerFlagIpRequestReasonsInner
• IpControllerUnflagIpRequest
• ManagementControllerAllClients200Response
• ManagementControllerAllClients200ResponseData
• ManagementControllerAllClients200ResponseDataPagination
• ManagementControllerAllClients400Response
• ManagementControllerAllClients404Response
• ManagementControllerAllClients500Response
• ManagementControllerGetClient200Response
• ManagementControllerGetClient400Response
• ManagementControllerGetClient404Response
• ManagementControllerGetClient500Response
• ManagementControllerRegisterClient201Response
• ManagementControllerRegisterClient201ResponseData
• ManagementControllerRegisterClient400Response
• ManagementControllerRegisterClient409Response
• ManagementControllerRegisterClient409ResponseError
• ManagementControllerRegisterClient500Response
• ManagementControllerRegisterClientRequest
• ManagementControllerRemoveClient200Response
• ManagementControllerRemoveClient200ResponseData
• ManagementControllerRemoveClient400Response
• ManagementControllerRemoveClient500Response
• ManagementControllerRemoveClientRequest
• ManagementControllerUpdateClient200Response
• ManagementControllerUpdateClient200ResponseData
• ManagementControllerUpdateClient400Response
• ManagementControllerUpdateClient500Response
• ManagementControllerUpdateClientRequest
• MandateControllerCreateCartMandate201Response
• MandateControllerCreateCartMandate201ResponseData
• MandateControllerCreateCartMandateRequest
• MandateControllerCreateCartMandateRequestItemsInner
• MandateControllerCreateIntentMandateRequest
• MandateControllerCreatePaymentMandateRequest
• MandateControllerCreateSignedPaymentMandateRequest
• MandateControllerCreateSignedPaymentMandateRequestUserAuthorization
• ReportingControllerRemoveReportRequest
• ReportingControllerReportClientRequest
• ReportingControllerReportClientRequestReasonsInner

Documentation For Authorization

Authentication schemes defined for the API:

DPoP

• Type: Bearer authentication (DPoP)

Author