Matchai Docs

Create a drop linkComing soon

Creates a link anyone can use to upload files into one listing or conversation, without an account — for example to collect documents from a seller or a notary.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
POST
/drop-links

Coming soon. Creates a link anyone can use to upload files into one listing or conversation, without an account — for example to collect documents from a seller or a notary. It stops working after expires_in_days. Files that arrive send drop_link.upload_received.

Scopes: documents:write

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: documents:write

Header Parameters

Idempotency-Key?string

A unique string (a UUID works). Retrying with the same key within 24 hours returns the first response instead of acting twice. Reusing a key with a different body returns 409 idempotency_key_reused.

Length1 <= length <= 255

Request Body

application/json
  1. body
place*
label*string

Shown to a stranger: say what you want, not who it is for.

Length1 <= length <= 120
expires_in_days?integer

Defaults to 7.

Range1 <= value <= 30
max_uploads?integer

Files it accepts at most.

Range1 <= value <= 100

Response Body

The drop link.

application/json
  1. response

A link anyone can use to upload files into one listing or conversation, without an account.

id*string

Drop link id.

Length1 <= length <= 64
url*string

The link to share.

Formaturi
label*string

What it asks for, shown to the person uploading.

place*

Somewhere a document lives in Matchai Cloud.

expires_at?|

Stops working.

Formatdate-time
max_uploads?|

Files it accepts at most.

Range1 <= value
upload_count*integer

Files received.

Range0 <= value
bytes_used*integer

Bytes received.

Range0 <= value
revoked_at?|

Revoked.

Formatdate-time
created_at*string

Created.

Formatdate-time
Example Request
curl -X POST 'https://api.matchai.co/v1/drop-links' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d' \  -H 'Content-Type: application/json' \  -d '{  "place": {    "type": "listing",    "id": "string"  },  "label": "string"}'
Example Response
{  "id": "string",  "url": "http://example.com",  "label": "string",  "place": {    "type": "listing",    "id": "string",    "name": "string"  },  "expires_at": "2019-08-24T14:15:22Z",  "max_uploads": 1,  "upload_count": 0,  "bytes_used": 0,  "revoked_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}