Initiate a batch-process

This endpoint initiates a batch process asynchronously for a given workflow type.

The response will return an identifier that can be used to retrieve the file processing status by polling GET /v2/batch-processing/{identifier}.

The workflow types available are:

  1. Create and screen a batch of customers

This workflow will initiate all of the steps in the 'Create and screen customer asynchronously' for each of the customers in your file.

The response will include an identifier that can be used to check the status of the batch process,as well as any validation errors that have caused the file to not be processed.

You need the Create and screen customers permission to use this endpoint.

Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!