Create a new bulk-upload job

POST

/v1/bulk-uploads

curl --request POST \
  --url https://aggregator.example.com/v1/bulk-uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "participant_type": "example" }'

• Your deployment's public host (set per instance)
• Local development

Reserves a pending bulk-upload job for the caller aggregator and returns a pre-signed S3 PUT URL. The browser uploads CSV bytes directly to S3, then calls /start. participant_type is validated against the active network config at request time.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

participant_type

required

Participant domain id declared by the active network (e.g. seeker, provider).

string

>= 1 characters

key

additional properties

any

Example^generated

{
  "participant_type": "example"
}

Responses

201

Default Response

Media typeapplication/json

object

upload_id

required

string

upload_url

required

string

s3_key

required

string

expires_at

required

string

content_type

required

string

max_bytes

required

number

schema_id

required

string

schema_version

required

string

status

required

string

key

additional properties

any

Example^generated

{
  "upload_id": "example",
  "upload_url": "example",
  "s3_key": "example",
  "expires_at": "example",
  "content_type": "example",
  "max_bytes": 1,
  "schema_id": "example",
  "schema_version": "example",
  "status": "example"
}

400

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

401

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

403

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

503

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}