# 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

Credits balance

### Get credits

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

## Certifications

File and hash certifications (certifications)

### Create a file certification

 - [POST /v1/file-certifications](https://truescreen.redocly.app/openapi/certifications/filecertificationspost.md): Creates a new certification from uploaded files (upload session)

### Create file certification attachments

 - [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

### Create a hash certification

 - [POST /v1/hash-certifications](https://truescreen.redocly.app/openapi/certifications/hashcertificationspost.md): Creates a new certification from file hashes (no upload)

### Create a data certification

 - [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 certification by report ID

 - [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 succeeded), the API responds with an HTTP status code appropriate to the failure and an application/problem+json body using the same ErrorResponseRfc shape as other errors.

404 applies when the reportId does not exist or is not visible to the caller.

### Certification webhook callback

 - [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 specification.
The payload uses a standard envelope with type, timestamp and data fields.
Every callback is signed with HMAC-SHA256 via the webhook-id, webhook-timestamp, and webhook-signature headers.

Authentication: this is a server-to-client callback, authenticity is verified via the webhook-signature header using a dedicated signing secret (whsec_-prefixed).

## TrueFlows

True Flow

### List templates

 - [GET /v1/templates](https://truescreen.redocly.app/openapi/trueflows/templatesgetall.md): Returns a list of the flow templates available for the api key

### Create a TrueFlow

 - [POST /v1/true-flows](https://truescreen.redocly.app/openapi/trueflows/trueflowspost.md): Creates a new TrueFlow from a template

### Create trueflow attachment

 - [POST /v1/true-flows-attachments](https://truescreen.redocly.app/openapi/trueflows/trueflowsattachmentspost.md): Create an Attachment for a TrueFlow