cardscan-client 0.2.0

Python CardScan API client

cardscan-client

The official python client for the CardScan API

Requirements.

Python 3.8+

Installation & Usage

pip install cardscan-client

Getting Started

Please follow the installation procedure and then run the following:

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	POST /cards	Creates a new card
CardScanApi	create_eligibility	POST /eligibility	Create Eligibility Record
CardScanApi	delete_card_by_id	DELETE /cards/{card_id}	Delete Card
CardScanApi	direct_upload	POST /cards/{card_id}/upload	Direct Upload
CardScanApi	generate_card_upload_url	POST /cards/{card_id}/generate-upload-url	Card - Generate Upload URL
CardScanApi	generate_magic_link	GET /generate-magic-link	Generate Magic Link
CardScanApi	generate_upload_url	GET /generate-upload-url	Generate an upload URL
CardScanApi	get_access_token	GET /access-token	Access Token
CardScanApi	get_card_by_id	GET /cards/{card_id}	Get Card by ID
CardScanApi	get_eligibility_by_id	GET /eligibility/{eligibility_id}	Get Eligibility
CardScanApi	get_scan_metadata	GET /scans/{scan_id}/metadata	Get Scan Metadata
CardScanApi	list_cards	GET /cards	List Cards
CardScanApi	list_eligibility	GET /eligibility	List Eligibility
CardScanApi	search_cards	GET /cards/search	Search Cards (200) OK
CardScanApi	validate_magic_link	GET /validate-magic-link	Validate Magic Link

Documentation For Models

• Address
• ApiErrorResponse
• CardApiResponse
• CardApiResponseDetails
• CardApiResponseImages
• CardApiResponseImagesBack
• CardApiResponseImagesFront
• CardState
• CardWebsocketEvent
• CoInsurance
• CoPayment
• CoverageSummary
• CreateCardRequest
• CreateCardRequestBackside
• CreateEligibilityRequest
• Deductible
• DirectUpload200Response
• DirectUpload200ResponseMetadata
• DirectUploadRequest
• EligibilityApiResponse
• EligibilityApiResponseEligibilityRequest
• EligibilityApiResponseEligibilityRequestSubscriber
• EligibilityApiResponseError
• EligibilityInfo
• EligibilityState
• EligibilitySummarizedResponse
• EligibilityWebsocketEvent
• GenerateCardUploadUrl200Response
• GenerateCardUploadUrlRequest
• GenerateMagicLink200Response
• GetAccessToken200Response
• GetAccessToken500Response
• ListEligibility200Response
• MatchScore
• OOP
• PayerDetails
• PlanDetails
• ProviderDto
• ResponseMetadata
• ScanCaptureType
• ScanMetadata
• ScanMetadataCameraCapabilities
• ScanMetadataCameraCapabilitiesAspectRatio
• ScanMetadataCaptureCanvas
• ScanMetadataCaptureScore
• ScanMetadataCaptureScoreScoresInner
• ScanMetadataGuides
• ScanMetadataVideoBackground
• ScanMetadataVideoTrack
• ScanMetadataWindowInner
• ScanOrientation
• SearchCards200Response
• Service
• SubscriberDetails
• SubscriberDto
• UploadParameters
• ValidateMagicLink200Response

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication

Author