# TrueScreen API

TrueScreen API for TrueFlow creation and Certification

Version: 1.5.0
License: Commercial

## Servers

Test
```
https://api-stg.truescreen.io
```

Production
```
https://api.truescreen.io
```

## Security

### ApiKeyAuth

API key passed in the Authorization header as a Bearer token

Type: http
Scheme: bearer
Bearer Format: API Key

## Download OpenAPI description

 - [TrueScreen API](https://truescreen.redocly.app/_bundle/openapi.yaml)

## Credits

 - [GET /v1/credits](https://truescreen.redocly.app/openapi/credits/creditsget.md): Returns the current credits balance for the API key
## Certifications

 - [POST /v1/file-certifications](https://truescreen.redocly.app/openapi/certifications/filecertificationspost.md): Creates a new certification from uploaded files (upload session)
 - [POST /v1/file-certifications-attachments](https://truescreen.redocly.app/openapi/certifications/filecertificationsattachmentspost.md): Request upload URLs for files to be included in a file certification
 - [POST /v1/hash-certifications](https://truescreen.redocly.app/openapi/certifications/hashcertificationspost.md): Creates a new certification from file hashes (no upload)
 - [POST /v1/data-certifications](https://truescreen.redocly.app/openapi/certifications/datacertificationspost.md): Creates a new certification from key-value string data (no file or hash)
 - [GET /v1/certifications/{reportId}](https://truescreen.redocly.app/openapi/certifications/certificationsgetbyreportid.md): Returns a certification by its report ID. While processing or when completed, signed download URLs are included in `files`. If processing **fails asynchronously** (after the creation `POST` has succee
 - [POST certificationCallback](https://truescreen.redocly.app/openapi/certifications/certificationcallback.md): Sent to the webhook_url when certification processing finishes (success or failure). Follows the [Standard Webhooks](https://www.standardwebhooks.com) specification. The payload uses a standard envelo
## TrueFlows

 - [GET /v1/templates](https://truescreen.redocly.app/openapi/trueflows/templatesgetall.md): Returns a list of the flow templates available for the api key
 - [POST /v1/true-flows](https://truescreen.redocly.app/openapi/trueflows/trueflowspost.md): Creates a new TrueFlow from a template
 - [POST /v1/true-flows-attachments](https://truescreen.redocly.app/openapi/trueflows/trueflowsattachmentspost.md): Create an Attachment for a TrueFlow