# cardscan-client
The official python client for the CardScan API
## Requirements.
Python 3.8+
## Installation & Usage
```bash
pip install cardscan-client
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from cardscan_client.api_client import ApiClient
from cardscan_client.api.card_scan_api import CardScanApi
from cardscan_client.configuration import Configuration
from cardscan_client.exceptions import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://sandbox.cardscan.ai/v1
# See configuration.py for a list of all supported configuration parameters.
# 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: bearerAuth
configuration = Configuration(
api_key=os.environ['API_KEY'],
environment='sandbox'
)
def main():
client = CardScanApi(api_client=ApiClient(configuration=configuration))
try:
api_response = client.full_scan(front_image_path="test/cards/front.jpg")
pprint(api_response)
except ApiException as e:
print("Exception when calling FullScan->full_scan: %s\n" % e)
if __name__ == "__main__":
main()
```
## Documentation for API Endpoints
All URIs are relative to *https://sandbox.cardscan.ai/v1*
| Class | Method | HTTP request | Description |
| ------------- | ---------------------------------------------------------------------------- | --------------------------------------------- | -------------------------- |
| _CardScanApi_ | [**create_card**](docs/CardScanApi.md#create_card) | **POST** /cards | Creates a new card |
| _CardScanApi_ | [**create_eligibility**](docs/CardScanApi.md#create_eligibility) | **POST** /eligibility | Create Eligibility Record |
| _CardScanApi_ | [**delete_card_by_id**](docs/CardScanApi.md#delete_card_by_id) | **DELETE** /cards/{card_id} | Delete Card |
| _CardScanApi_ | [**direct_upload**](docs/CardScanApi.md#direct_upload) | **POST** /cards/{card_id}/upload | Direct Upload |
| _CardScanApi_ | [**generate_card_upload_url**](docs/CardScanApi.md#generate_card_upload_url) | **POST** /cards/{card_id}/generate-upload-url | Card - Generate Upload URL |
| _CardScanApi_ | [**generate_magic_link**](docs/CardScanApi.md#generate_magic_link) | **GET** /generate-magic-link | Generate Magic Link |
| _CardScanApi_ | [**generate_upload_url**](docs/CardScanApi.md#generate_upload_url) | **GET** /generate-upload-url | Generate an upload URL |
| _CardScanApi_ | [**get_access_token**](docs/CardScanApi.md#get_access_token) | **GET** /access-token | Access Token |
| _CardScanApi_ | [**get_card_by_id**](docs/CardScanApi.md#get_card_by_id) | **GET** /cards/{card_id} | Get Card by ID |
| _CardScanApi_ | [**get_eligibility_by_id**](docs/CardScanApi.md#get_eligibility_by_id) | **GET** /eligibility/{eligibility_id} | Get Eligibility |
| _CardScanApi_ | [**get_scan_metadata**](docs/CardScanApi.md#get_scan_metadata) | **GET** /scans/{scan_id}/metadata | Get Scan Metadata |
| _CardScanApi_ | [**list_cards**](docs/CardScanApi.md#list_cards) | **GET** /cards | List Cards |
| _CardScanApi_ | [**list_eligibility**](docs/CardScanApi.md#list_eligibility) | **GET** /eligibility | List Eligibility |
| _CardScanApi_ | [**search_cards**](docs/CardScanApi.md#search_cards) | **GET** /cards/search | Search Cards (200) OK |
| _CardScanApi_ | [**validate_magic_link**](docs/CardScanApi.md#validate_magic_link) | **GET** /validate-magic-link | Validate Magic Link |
## Documentation For Models
- [Address](docs/Address.md)
- [ApiErrorResponse](docs/ApiErrorResponse.md)
- [CardApiResponse](docs/CardApiResponse.md)
- [CardApiResponseDetails](docs/CardApiResponseDetails.md)
- [CardApiResponseImages](docs/CardApiResponseImages.md)
- [CardApiResponseImagesBack](docs/CardApiResponseImagesBack.md)
- [CardApiResponseImagesFront](docs/CardApiResponseImagesFront.md)
- [CardState](docs/CardState.md)
- [CardWebsocketEvent](docs/CardWebsocketEvent.md)
- [CoInsurance](docs/CoInsurance.md)
- [CoPayment](docs/CoPayment.md)
- [CoverageSummary](docs/CoverageSummary.md)
- [CreateCardRequest](docs/CreateCardRequest.md)
- [CreateCardRequestBackside](docs/CreateCardRequestBackside.md)
- [CreateEligibilityRequest](docs/CreateEligibilityRequest.md)
- [Deductible](docs/Deductible.md)
- [DirectUpload200Response](docs/DirectUpload200Response.md)
- [DirectUpload200ResponseMetadata](docs/DirectUpload200ResponseMetadata.md)
- [DirectUploadRequest](docs/DirectUploadRequest.md)
- [EligibilityApiResponse](docs/EligibilityApiResponse.md)
- [EligibilityApiResponseEligibilityRequest](docs/EligibilityApiResponseEligibilityRequest.md)
- [EligibilityApiResponseEligibilityRequestSubscriber](docs/EligibilityApiResponseEligibilityRequestSubscriber.md)
- [EligibilityApiResponseError](docs/EligibilityApiResponseError.md)
- [EligibilityInfo](docs/EligibilityInfo.md)
- [EligibilityState](docs/EligibilityState.md)
- [EligibilitySummarizedResponse](docs/EligibilitySummarizedResponse.md)
- [EligibilityWebsocketEvent](docs/EligibilityWebsocketEvent.md)
- [GenerateCardUploadUrl200Response](docs/GenerateCardUploadUrl200Response.md)
- [GenerateCardUploadUrlRequest](docs/GenerateCardUploadUrlRequest.md)
- [GenerateMagicLink200Response](docs/GenerateMagicLink200Response.md)
- [GetAccessToken200Response](docs/GetAccessToken200Response.md)
- [GetAccessToken500Response](docs/GetAccessToken500Response.md)
- [ListEligibility200Response](docs/ListEligibility200Response.md)
- [MatchScore](docs/MatchScore.md)
- [OOP](docs/OOP.md)
- [PayerDetails](docs/PayerDetails.md)
- [PlanDetails](docs/PlanDetails.md)
- [ProviderDto](docs/ProviderDto.md)
- [ResponseMetadata](docs/ResponseMetadata.md)
- [ScanCaptureType](docs/ScanCaptureType.md)
- [ScanMetadata](docs/ScanMetadata.md)
- [ScanMetadataCameraCapabilities](docs/ScanMetadataCameraCapabilities.md)
- [ScanMetadataCameraCapabilitiesAspectRatio](docs/ScanMetadataCameraCapabilitiesAspectRatio.md)
- [ScanMetadataCaptureCanvas](docs/ScanMetadataCaptureCanvas.md)
- [ScanMetadataCaptureScore](docs/ScanMetadataCaptureScore.md)
- [ScanMetadataCaptureScoreScoresInner](docs/ScanMetadataCaptureScoreScoresInner.md)
- [ScanMetadataGuides](docs/ScanMetadataGuides.md)
- [ScanMetadataVideoBackground](docs/ScanMetadataVideoBackground.md)
- [ScanMetadataVideoTrack](docs/ScanMetadataVideoTrack.md)
- [ScanMetadataWindowInner](docs/ScanMetadataWindowInner.md)
- [ScanOrientation](docs/ScanOrientation.md)
- [SearchCards200Response](docs/SearchCards200Response.md)
- [Service](docs/Service.md)
- [SubscriberDetails](docs/SubscriberDetails.md)
- [SubscriberDto](docs/SubscriberDto.md)
- [UploadParameters](docs/UploadParameters.md)
- [ValidateMagicLink200Response](docs/ValidateMagicLink200Response.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth
- **Type**: Bearer authentication
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/CardScan-ai/api-clients.git",
"name": "cardscan-client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "CardScan, CardScan client, CardScan API client",
"author": "Team CardScan",
"author_email": "dev@cardscan.ai",
"download_url": "https://files.pythonhosted.org/packages/00/55/18d531dff9f72e37ae0429cadf481f3410752313e23549f2d816fc2dfbd4/cardscan_client-0.8.0.tar.gz",
"platform": null,
"description": "# cardscan-client\n\nThe official python client for the CardScan API\n\n## Requirements.\n\nPython 3.8+\n\n## Installation & Usage\n\n```bash\npip install cardscan-client\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom cardscan_client.api_client import ApiClient\nfrom cardscan_client.api.card_scan_api import CardScanApi\nfrom cardscan_client.configuration import Configuration\nfrom cardscan_client.exceptions import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://sandbox.cardscan.ai/v1\n# See configuration.py for a list of all supported configuration parameters.\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization: bearerAuth\nconfiguration = Configuration(\n api_key=os.environ['API_KEY'],\n environment='sandbox'\n)\n\n\ndef main():\n client = CardScanApi(api_client=ApiClient(configuration=configuration))\n\n try:\n api_response = client.full_scan(front_image_path=\"test/cards/front.jpg\")\n\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling FullScan->full_scan: %s\\n\" % e)\n\n\nif __name__ == \"__main__\":\n main()\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://sandbox.cardscan.ai/v1*\n\n| Class | Method | HTTP request | Description |\n| ------------- | ---------------------------------------------------------------------------- | --------------------------------------------- | -------------------------- |\n| _CardScanApi_ | [**create_card**](docs/CardScanApi.md#create_card) | **POST** /cards | Creates a new card |\n| _CardScanApi_ | [**create_eligibility**](docs/CardScanApi.md#create_eligibility) | **POST** /eligibility | Create Eligibility Record |\n| _CardScanApi_ | [**delete_card_by_id**](docs/CardScanApi.md#delete_card_by_id) | **DELETE** /cards/{card_id} | Delete Card |\n| _CardScanApi_ | [**direct_upload**](docs/CardScanApi.md#direct_upload) | **POST** /cards/{card_id}/upload | Direct Upload |\n| _CardScanApi_ | [**generate_card_upload_url**](docs/CardScanApi.md#generate_card_upload_url) | **POST** /cards/{card_id}/generate-upload-url | Card - Generate Upload URL |\n| _CardScanApi_ | [**generate_magic_link**](docs/CardScanApi.md#generate_magic_link) | **GET** /generate-magic-link | Generate Magic Link |\n| _CardScanApi_ | [**generate_upload_url**](docs/CardScanApi.md#generate_upload_url) | **GET** /generate-upload-url | Generate an upload URL |\n| _CardScanApi_ | [**get_access_token**](docs/CardScanApi.md#get_access_token) | **GET** /access-token | Access Token |\n| _CardScanApi_ | [**get_card_by_id**](docs/CardScanApi.md#get_card_by_id) | **GET** /cards/{card_id} | Get Card by ID |\n| _CardScanApi_ | [**get_eligibility_by_id**](docs/CardScanApi.md#get_eligibility_by_id) | **GET** /eligibility/{eligibility_id} | Get Eligibility |\n| _CardScanApi_ | [**get_scan_metadata**](docs/CardScanApi.md#get_scan_metadata) | **GET** /scans/{scan_id}/metadata | Get Scan Metadata |\n| _CardScanApi_ | [**list_cards**](docs/CardScanApi.md#list_cards) | **GET** /cards | List Cards |\n| _CardScanApi_ | [**list_eligibility**](docs/CardScanApi.md#list_eligibility) | **GET** /eligibility | List Eligibility |\n| _CardScanApi_ | [**search_cards**](docs/CardScanApi.md#search_cards) | **GET** /cards/search | Search Cards (200) OK |\n| _CardScanApi_ | [**validate_magic_link**](docs/CardScanApi.md#validate_magic_link) | **GET** /validate-magic-link | Validate Magic Link |\n\n## Documentation For Models\n\n- [Address](docs/Address.md)\n- [ApiErrorResponse](docs/ApiErrorResponse.md)\n- [CardApiResponse](docs/CardApiResponse.md)\n- [CardApiResponseDetails](docs/CardApiResponseDetails.md)\n- [CardApiResponseImages](docs/CardApiResponseImages.md)\n- [CardApiResponseImagesBack](docs/CardApiResponseImagesBack.md)\n- [CardApiResponseImagesFront](docs/CardApiResponseImagesFront.md)\n- [CardState](docs/CardState.md)\n- [CardWebsocketEvent](docs/CardWebsocketEvent.md)\n- [CoInsurance](docs/CoInsurance.md)\n- [CoPayment](docs/CoPayment.md)\n- [CoverageSummary](docs/CoverageSummary.md)\n- [CreateCardRequest](docs/CreateCardRequest.md)\n- [CreateCardRequestBackside](docs/CreateCardRequestBackside.md)\n- [CreateEligibilityRequest](docs/CreateEligibilityRequest.md)\n- [Deductible](docs/Deductible.md)\n- [DirectUpload200Response](docs/DirectUpload200Response.md)\n- [DirectUpload200ResponseMetadata](docs/DirectUpload200ResponseMetadata.md)\n- [DirectUploadRequest](docs/DirectUploadRequest.md)\n- [EligibilityApiResponse](docs/EligibilityApiResponse.md)\n- [EligibilityApiResponseEligibilityRequest](docs/EligibilityApiResponseEligibilityRequest.md)\n- [EligibilityApiResponseEligibilityRequestSubscriber](docs/EligibilityApiResponseEligibilityRequestSubscriber.md)\n- [EligibilityApiResponseError](docs/EligibilityApiResponseError.md)\n- [EligibilityInfo](docs/EligibilityInfo.md)\n- [EligibilityState](docs/EligibilityState.md)\n- [EligibilitySummarizedResponse](docs/EligibilitySummarizedResponse.md)\n- [EligibilityWebsocketEvent](docs/EligibilityWebsocketEvent.md)\n- [GenerateCardUploadUrl200Response](docs/GenerateCardUploadUrl200Response.md)\n- [GenerateCardUploadUrlRequest](docs/GenerateCardUploadUrlRequest.md)\n- [GenerateMagicLink200Response](docs/GenerateMagicLink200Response.md)\n- [GetAccessToken200Response](docs/GetAccessToken200Response.md)\n- [GetAccessToken500Response](docs/GetAccessToken500Response.md)\n- [ListEligibility200Response](docs/ListEligibility200Response.md)\n- [MatchScore](docs/MatchScore.md)\n- [OOP](docs/OOP.md)\n- [PayerDetails](docs/PayerDetails.md)\n- [PlanDetails](docs/PlanDetails.md)\n- [ProviderDto](docs/ProviderDto.md)\n- [ResponseMetadata](docs/ResponseMetadata.md)\n- [ScanCaptureType](docs/ScanCaptureType.md)\n- [ScanMetadata](docs/ScanMetadata.md)\n- [ScanMetadataCameraCapabilities](docs/ScanMetadataCameraCapabilities.md)\n- [ScanMetadataCameraCapabilitiesAspectRatio](docs/ScanMetadataCameraCapabilitiesAspectRatio.md)\n- [ScanMetadataCaptureCanvas](docs/ScanMetadataCaptureCanvas.md)\n- [ScanMetadataCaptureScore](docs/ScanMetadataCaptureScore.md)\n- [ScanMetadataCaptureScoreScoresInner](docs/ScanMetadataCaptureScoreScoresInner.md)\n- [ScanMetadataGuides](docs/ScanMetadataGuides.md)\n- [ScanMetadataVideoBackground](docs/ScanMetadataVideoBackground.md)\n- [ScanMetadataVideoTrack](docs/ScanMetadataVideoTrack.md)\n- [ScanMetadataWindowInner](docs/ScanMetadataWindowInner.md)\n- [ScanOrientation](docs/ScanOrientation.md)\n- [SearchCards200Response](docs/SearchCards200Response.md)\n- [Service](docs/Service.md)\n- [SubscriberDetails](docs/SubscriberDetails.md)\n- [SubscriberDto](docs/SubscriberDto.md)\n- [UploadParameters](docs/UploadParameters.md)\n- [ValidateMagicLink200Response](docs/ValidateMagicLink200Response.md)\n\n<a id=\"documentation-for-authorization\"></a>\n\n## Documentation For Authorization\n\nAuthentication schemes defined for the API:\n<a id=\"bearerAuth\"></a>\n\n### bearerAuth\n\n- **Type**: Bearer authentication\n\n## Author\n",
"bugtrack_url": null,
"license": "SEE LICENSE IN LICENSE.md",
"summary": "Python CardScan API client",
"version": "0.8.0",
"project_urls": {
"Homepage": "https://github.com/CardScan-ai/api-clients.git",
"Repository": "https://github.com/CardScan-ai/api-clients.git"
},
"split_keywords": [
"cardscan",
" cardscan client",
" cardscan api client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c6ef26d6da1f2a38f2adfcbdcf8f3ccd6b5f8329428ff0c847a96206849969e2",
"md5": "fa55df7030accdad27c523a1d45ba24b",
"sha256": "b6fbfe1cbb99f19efb6885c063f45926ee1def33fc7baab33da3abc902e70380"
},
"downloads": -1,
"filename": "cardscan_client-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fa55df7030accdad27c523a1d45ba24b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 141673,
"upload_time": "2024-12-12T21:42:34",
"upload_time_iso_8601": "2024-12-12T21:42:34.850063Z",
"url": "https://files.pythonhosted.org/packages/c6/ef/26d6da1f2a38f2adfcbdcf8f3ccd6b5f8329428ff0c847a96206849969e2/cardscan_client-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "005518d531dff9f72e37ae0429cadf481f3410752313e23549f2d816fc2dfbd4",
"md5": "8ec71b30751fa6e0e535530ba80e8715",
"sha256": "e2b3725dbc88d02e04a78f1ac92e021c45e0d71842eb1d2cdda40edeca2b251b"
},
"downloads": -1,
"filename": "cardscan_client-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "8ec71b30751fa6e0e535530ba80e8715",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 60252,
"upload_time": "2024-12-12T21:42:41",
"upload_time_iso_8601": "2024-12-12T21:42:41.096265Z",
"url": "https://files.pythonhosted.org/packages/00/55/18d531dff9f72e37ae0429cadf481f3410752313e23549f2d816fc2dfbd4/cardscan_client-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 21:42:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CardScan-ai",
"github_project": "api-clients",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cardscan-client"
}
JSON
