Bulk Upload

get

Generate a presigned S3 URL for uploading monthly delta files containing additions and deletions. Returns an upload_link and operation_id for tracking file processing status.

File Format Requirements

Uploaded files must be in JSON format and follow this structure:

[{
    "merchantLegalName": "Acme Corp", // Required
    "merchantDBA": null,
    "merchantId": null, # our Verdata ID for this merchant
    "merchantExternalId": null, // Your internal ID for this merchant
    "merchantEIN": null,

    "merchantAddress": "123 Main St", // Required
    "merchantCity": "New York", // Required
    "merchantState": "NY", // Required
    "merchantZip": "10001", // Required
    "merchantPhone": null,
    "merchantEmail": null,
    "merchantWebsite": null,

    "contacts": [
        {
        "contactName": null,
        "contactAddress": null,
        "contactCity": null,
        "contactState": null,
        "contactZip": null,
        "contactPhone": null,
        "contactEmail": null,
        "contactWebsite": null
        }
    ],

    "openDate": "2023-01-01", // Required
    "closedDate": null,

    "FraudClose": null,
    "PerformanceClose": null,
    "ComplianceClose": null,
    "UnderwritingClose": null,
    "OOBClose": null,
    "OtherClose": null,

    "enchancedMonitoring": false // Unused: planned for future use
}]

Authorizations

Token

AuthorizationstringRequired

Header parameters

LenderIdstringRequired

Lender ID provided by Verdata

Responses

200

Bulk Upload Response

No content

get

/bulk_upload

HTTPcURLJavaScriptPython

GET /external/api/v1/bulk_upload HTTP/1.1
Host: api.myverdata.com
Authorization: YOUR_API_KEY
LenderId: text
Accept: */*

200

Bulk Upload Response

No content

get

Check the status of a bulk upload operation by operation_id. Returns the current status and processing details.

Authorizations

Token

AuthorizationstringRequired

Path parameters

operation_idstringRequired

Header parameters

LenderIdstringRequired

Lender ID provided by Verdata

Responses

200

Bulk Upload Status Response

No content

get

/bulk_upload/{operation_id}

HTTPcURLJavaScriptPython

GET /external/api/v1/bulk_upload/{operation_id} HTTP/1.1
Host: api.myverdata.com
Authorization: YOUR_API_KEY
LenderId: text
Accept: */*

200

Bulk Upload Status Response

No content