Batches
Developer Documents‣Optimize Verify‣Batches

Uploads a csv file describing a batch API request. The CSV format varies according to your Verify profile.

Log in to the Verify merchant portal to download an example of the CSV format required from the ‘Batch Run’ section, where you can view and manage all your transaction batch uploads.

API Response Examples
Batch upload for profile eKYC

POST /api/batches
Content-Type: multipart/form-data; boundary=--------

--------
Content-Disposition: form-data; name="ProfileShortCode"

eKYC
--------
Content-Disposition: form-data; name="Name"

TestBatch1
--------
Content-Disposition: form-data; name="RunImmediately"

false
--------
Content-Disposition: form-data; name="File"; filename="/C:/Users/User/eKYC.csv"
Content-Type: text/csv

(data)
--------


HTTP/1.1 200
{
    "batchId": 583,
    "batchStatus": "Importing"
}
API Endpoint
endpoint: /optimizeverify/batches
method: POST
summary: imports the provided batch file and starts the batch import
headers:

Name
Value
Description

Authorization
Basic <base64(licencekey:clientkey)>
Standard “Basic” HTTP authentication scheme as definined in RFC 7617. The username component is your licence key and the password is your client key.

Content-Type
multipart/form-data

request body:
ProfileShortCode string
The profile ShortCode identifying the profile.
Name string
The name of the batch.
RunImmediately boolean
Whether to start the batch now or later from the UI. (default: true).
File file
The .csv file to import.
response:
{
batchId int
The id of the imported batch.
batchStatus string
Possible Values: Importing, ImportingAndToBeRun
The status of the batch depending on “RunImmediately”.
}