signet-core 1.0.0
Credentials Service API
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, 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](https://openapi-generator.tech) 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:

```sh
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:
```python
import signet_core
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import signet_core
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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**](docs/BlacklistApi.md#blacklist_controller_blacklist_client) | **POST** /fraud/v1/blacklist | Add client to blacklist
*BlacklistApi* | [**blacklist_controller_check_blacklist**](docs/BlacklistApi.md#blacklist_controller_check_blacklist) | **GET** /fraud/v1/blacklist/client/{clientId} | Check if client is blacklisted
*BlacklistApi* | [**blacklist_controller_get_blacklisted_clients**](docs/BlacklistApi.md#blacklist_controller_get_blacklisted_clients) | **GET** /fraud/v1/blacklist/all | Get all blacklisted clients
*BlacklistApi* | [**blacklist_controller_remove_blacklist_client**](docs/BlacklistApi.md#blacklist_controller_remove_blacklist_client) | **DELETE** /fraud/v1/blacklist | Remove client from blacklist
*CommsApi* | [**comms_controller_check_client_status**](docs/CommsApi.md#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**](docs/DeviceApi.md#device_controller_device_check_for_user) | **GET** /fraud/v1/device/{deviceId}/{userId} | Check if device is flagged for user
*DeviceApi* | [**device_controller_flag_device**](docs/DeviceApi.md#device_controller_flag_device) | **POST** /fraud/v1/device | Flag device
*DeviceApi* | [**device_controller_get_flagged_devices**](docs/DeviceApi.md#device_controller_get_flagged_devices) | **GET** /fraud/v1/device/all | Get all flagged devices
*DeviceApi* | [**device_controller_unflag_device**](docs/DeviceApi.md#device_controller_unflag_device) | **DELETE** /fraud/v1/device | Remove device flag
*EnrollmentApi* | [**enrollment_controller_enroll_user**](docs/EnrollmentApi.md#enrollment_controller_enroll_user) | **POST** /credentials/v1/enrollment/user | Enroll a user
*GeoApi* | [**geo_controller_geo_verify**](docs/GeoApi.md#geo_controller_geo_verify) | **POST** /fraud/v1/geo/verify | Verify geographic location
*GeoApi* | [**geo_controller_get_failed_verifications**](docs/GeoApi.md#geo_controller_get_failed_verifications) | **GET** /fraud/v1/geo/failed/{clientId} | Get failed geo verifications
*GeoApi* | [**geo_controller_get_successful_verifications**](docs/GeoApi.md#geo_controller_get_successful_verifications) | **GET** /fraud/v1/geo/successful/{clientId} | Get successful geo verifications
*IpApi* | [**ip_controller_flag_ip**](docs/IpApi.md#ip_controller_flag_ip) | **POST** /fraud/v1/ip | Flag IP address
*IpApi* | [**ip_controller_get_flagged_ips**](docs/IpApi.md#ip_controller_get_flagged_ips) | **GET** /fraud/v1/ip/all | Get all flagged IPs
*IpApi* | [**ip_controller_ip_check_for_client**](docs/IpApi.md#ip_controller_ip_check_for_client) | **GET** /fraud/v1/ip/{ip}/{clientId} | Check if IP is flagged for client
*IpApi* | [**ip_controller_unflag_ip**](docs/IpApi.md#ip_controller_unflag_ip) | **DELETE** /fraud/v1/ip | Unflag IP address
*MandateApi* | [**mandate_controller_create_cart_mandate**](docs/MandateApi.md#mandate_controller_create_cart_mandate) | **POST** /credentials/v1/mandate/cart | Create a cart mandate
*MandateApi* | [**mandate_controller_create_intent_mandate**](docs/MandateApi.md#mandate_controller_create_intent_mandate) | **POST** /credentials/v1/mandate/intent | Create an intent mandate
*MandateApi* | [**mandate_controller_create_payment_mandate**](docs/MandateApi.md#mandate_controller_create_payment_mandate) | **POST** /credentials/v1/mandate/payment | Create a payment mandate
*MandateApi* | [**mandate_controller_create_signed_payment_mandate**](docs/MandateApi.md#mandate_controller_create_signed_payment_mandate) | **POST** /credentials/v1/mandate/payment/signed | Create a signed payment mandate
*MandateApi* | [**mandate_controller_get_mandate**](docs/MandateApi.md#mandate_controller_get_mandate) | **GET** /credentials/v1/mandate | Get mandates
*MandateApi* | [**mandate_controller_get_mandate_by_client_id**](docs/MandateApi.md#mandate_controller_get_mandate_by_client_id) | **GET** /credentials/v1/mandate/{clientId} | Get mandates by client ID
*PartnerApi* | [**management_controller_all_clients**](docs/PartnerApi.md#management_controller_all_clients) | **GET** /partner/v1/all-clients | Get All Clients
*PartnerApi* | [**management_controller_get_client**](docs/PartnerApi.md#management_controller_get_client) | **GET** /partner/v1/get-client/{clientId} | Get Client by ID
*PartnerApi* | [**management_controller_register_client**](docs/PartnerApi.md#management_controller_register_client) | **POST** /partner/v1/register-client | Register Client
*PartnerApi* | [**management_controller_remove_client**](docs/PartnerApi.md#management_controller_remove_client) | **DELETE** /partner/v1/remove-client | Remove Client
*PartnerApi* | [**management_controller_update_client**](docs/PartnerApi.md#management_controller_update_client) | **PATCH** /partner/v1/update-client | Update Client
*ReportingApi* | [**reporting_controller_check_client**](docs/ReportingApi.md#reporting_controller_check_client) | **GET** /fraud/v1/report/{clientId} | Check if client is flagged
*ReportingApi* | [**reporting_controller_get_all_reports**](docs/ReportingApi.md#reporting_controller_get_all_reports) | **GET** /fraud/v1/report/all | Get all fraud reports
*ReportingApi* | [**reporting_controller_remove_report**](docs/ReportingApi.md#reporting_controller_remove_report) | **DELETE** /fraud/v1/report | Remove fraud reports
*ReportingApi* | [**reporting_controller_report_client**](docs/ReportingApi.md#reporting_controller_report_client) | **POST** /fraud/v1/report | Report client for fraud


## Documentation For Models

 - [BlacklistControllerBlacklistClientRequest](docs/BlacklistControllerBlacklistClientRequest.md)
 - [BlacklistControllerBlacklistClientRequestReasonsInner](docs/BlacklistControllerBlacklistClientRequestReasonsInner.md)
 - [BlacklistControllerRemoveBlacklistClientRequest](docs/BlacklistControllerRemoveBlacklistClientRequest.md)
 - [CommsControllerCheckClientStatusRequest](docs/CommsControllerCheckClientStatusRequest.md)
 - [DeviceControllerFlagDeviceRequest](docs/DeviceControllerFlagDeviceRequest.md)
 - [DeviceControllerFlagDeviceRequestReasonsInner](docs/DeviceControllerFlagDeviceRequestReasonsInner.md)
 - [DeviceControllerUnflagDeviceRequest](docs/DeviceControllerUnflagDeviceRequest.md)
 - [EnrollmentControllerEnrollUser201Response](docs/EnrollmentControllerEnrollUser201Response.md)
 - [EnrollmentControllerEnrollUser201ResponseData](docs/EnrollmentControllerEnrollUser201ResponseData.md)
 - [EnrollmentControllerEnrollUser201ResponseDataMetadata](docs/EnrollmentControllerEnrollUser201ResponseDataMetadata.md)
 - [EnrollmentControllerEnrollUserRequest](docs/EnrollmentControllerEnrollUserRequest.md)
 - [GeoControllerGeoVerifyRequest](docs/GeoControllerGeoVerifyRequest.md)
 - [IpControllerFlagIpRequest](docs/IpControllerFlagIpRequest.md)
 - [IpControllerFlagIpRequestReasonsInner](docs/IpControllerFlagIpRequestReasonsInner.md)
 - [IpControllerUnflagIpRequest](docs/IpControllerUnflagIpRequest.md)
 - [ManagementControllerAllClients200Response](docs/ManagementControllerAllClients200Response.md)
 - [ManagementControllerAllClients200ResponseData](docs/ManagementControllerAllClients200ResponseData.md)
 - [ManagementControllerAllClients200ResponseDataPagination](docs/ManagementControllerAllClients200ResponseDataPagination.md)
 - [ManagementControllerAllClients400Response](docs/ManagementControllerAllClients400Response.md)
 - [ManagementControllerAllClients404Response](docs/ManagementControllerAllClients404Response.md)
 - [ManagementControllerAllClients500Response](docs/ManagementControllerAllClients500Response.md)
 - [ManagementControllerGetClient200Response](docs/ManagementControllerGetClient200Response.md)
 - [ManagementControllerGetClient400Response](docs/ManagementControllerGetClient400Response.md)
 - [ManagementControllerGetClient404Response](docs/ManagementControllerGetClient404Response.md)
 - [ManagementControllerGetClient500Response](docs/ManagementControllerGetClient500Response.md)
 - [ManagementControllerRegisterClient201Response](docs/ManagementControllerRegisterClient201Response.md)
 - [ManagementControllerRegisterClient201ResponseData](docs/ManagementControllerRegisterClient201ResponseData.md)
 - [ManagementControllerRegisterClient400Response](docs/ManagementControllerRegisterClient400Response.md)
 - [ManagementControllerRegisterClient409Response](docs/ManagementControllerRegisterClient409Response.md)
 - [ManagementControllerRegisterClient409ResponseError](docs/ManagementControllerRegisterClient409ResponseError.md)
 - [ManagementControllerRegisterClient500Response](docs/ManagementControllerRegisterClient500Response.md)
 - [ManagementControllerRegisterClientRequest](docs/ManagementControllerRegisterClientRequest.md)
 - [ManagementControllerRemoveClient200Response](docs/ManagementControllerRemoveClient200Response.md)
 - [ManagementControllerRemoveClient200ResponseData](docs/ManagementControllerRemoveClient200ResponseData.md)
 - [ManagementControllerRemoveClient400Response](docs/ManagementControllerRemoveClient400Response.md)
 - [ManagementControllerRemoveClient500Response](docs/ManagementControllerRemoveClient500Response.md)
 - [ManagementControllerRemoveClientRequest](docs/ManagementControllerRemoveClientRequest.md)
 - [ManagementControllerUpdateClient200Response](docs/ManagementControllerUpdateClient200Response.md)
 - [ManagementControllerUpdateClient200ResponseData](docs/ManagementControllerUpdateClient200ResponseData.md)
 - [ManagementControllerUpdateClient400Response](docs/ManagementControllerUpdateClient400Response.md)
 - [ManagementControllerUpdateClient500Response](docs/ManagementControllerUpdateClient500Response.md)
 - [ManagementControllerUpdateClientRequest](docs/ManagementControllerUpdateClientRequest.md)
 - [MandateControllerCreateCartMandate201Response](docs/MandateControllerCreateCartMandate201Response.md)
 - [MandateControllerCreateCartMandate201ResponseData](docs/MandateControllerCreateCartMandate201ResponseData.md)
 - [MandateControllerCreateCartMandateRequest](docs/MandateControllerCreateCartMandateRequest.md)
 - [MandateControllerCreateCartMandateRequestItemsInner](docs/MandateControllerCreateCartMandateRequestItemsInner.md)
 - [MandateControllerCreateIntentMandateRequest](docs/MandateControllerCreateIntentMandateRequest.md)
 - [MandateControllerCreatePaymentMandateRequest](docs/MandateControllerCreatePaymentMandateRequest.md)
 - [MandateControllerCreateSignedPaymentMandateRequest](docs/MandateControllerCreateSignedPaymentMandateRequest.md)
 - [MandateControllerCreateSignedPaymentMandateRequestUserAuthorization](docs/MandateControllerCreateSignedPaymentMandateRequestUserAuthorization.md)
 - [ReportingControllerRemoveReportRequest](docs/ReportingControllerRemoveReportRequest.md)
 - [ReportingControllerReportClientRequest](docs/ReportingControllerReportClientRequest.md)
 - [ReportingControllerReportClientRequestReasonsInner](docs/ReportingControllerReportClientRequestReasonsInner.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="DPoP"></a>
### DPoP

- **Type**: Bearer authentication (DPoP)


## Author