Create Verification Job

POST

/api/public/v1/verification-job

Used for authentication

Create Verification Job

The create verification job endpoint can match and verify audio or video files against the provided licensing information and any ClicknClear licenses.
ClicknClear licenses will be fetched automatically based on the provided email address.

Any songs found in the audio file will be matched against the license files provided.
The verification job process is asynchronous, on creation, you will receive the job with an ID, you can use this to poll the Get Verification Job Endpoint or you can set a webhook (preferred) for the ‘Verification Job - Status Update’ event, this event is fired when the job finishes processing. To setup a webhook please see the online documentation: https://github.com/ClicknClear/Public-Resources/blob/main/docs/verification/Verification.md#webhooks

The ‘Verification Job - Status Update’ webhook event is invoked with a minimal payload, the full verification job can then be fetched using the Get Verification Job endpoint. See ‘IVerificationJobStatusUpdateV1’ for the payload type.

For details on return types and the request payload please see the annotated typescript types: https://github.com/ClicknClear/Public-Resources/blob/main/packages/lvs-types/src/v1/verificationJob.ts

Authorizations

bearerAuth

Request Body

object

Example

{
  "name": "Tristan Barlow",
  "email": "tristan@clicknclear.com",
  "requiredTerritories": [
    "US",
    "GB"
  ],
  "startDate": "2024-09-01",
  "endDate": "2024-09-04",
  "externalId": "1234567890",
  "organisationId": 1,
  "audioFileURL": "https://clicknclear-public-resources.s3.eu-west-1.amazonaws.com/lvs/TEST_MIX.mp3",
  "tags": [
    "September Event 2024",
    "2024",
    "Seniors"
  ],
  "licenseDetails": [
    {
      "licenseSource": "Other",
      "licenseSourceName": "Other Platform",
      "licenseFileURLs": [
        "https://clicknclear-public-resources.s3.eu-west-1.amazonaws.com/lvs/TEST_LICENSE.pdf"
      ]
    }
  ]
}

Responses

200

object

Example

{
  "id": 4,
  "name": "Tristan Barlow",
  "email": "tristan@clicknclear.com",
  "requiredTerritories": [
    "US",
    "GB"
  ],
  "externalId": "1234567890",
  "organisationId": 1,
  "soundRecordingId": null,
  "errorMessage": "",
  "status": "Created",
  "endDate": "2024-09-04T00:00:00.000Z",
  "startDate": "2024-09-01T00:00:00.000Z",
  "tags": [
    "September Event 2024",
    "2024",
    "Seniors"
  ],
  "recording": null
}

Headers

Access-Control-Allow-Origin

string

Example

content-length

integer

Example

date

string

Example

Mon, 16 Sep 2024 16:45:08 GMT

connection

string

Example

close