API reference › Handshakes

Upload handshake documents (organization)

POST /v1/handshakes/{id}/documents

Scope
handshakes:edit
Roles
admin, scheduler

Multipart upload. Each entry may carry a file plus categories, tags and the document setting it satisfies. Documents are stamped as uploaded by the organization.

Parameters

Path parameters

NameTypeDescription
id requiredstring

Handshake ID.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

FieldTypeDescription
documents requiredarray of object

min items 1.

documents[].filestring (binary)
documents[].idinteger or null

Existing document to keep or update.

documents[].file_namestring
documents[].document_setting_idinteger or null

Example 1.

documents[].categoriesarray of string
documents[].tagsarray of string

Example

JSON
{
  "documents": [
    {
      "file": "string",
      "id": 0,
      "file_name": "string",
      "document_setting_id": 1,
      "categories": [
        "string"
      ],
      "tags": [
        "string"
      ]
    }
  ]
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/handshakes/{id}/documents" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"documents":[{"file":"string","id":0,"file_name":"string","document_setting_id":1,"categories":["string"],"tags":["string"]}]}'

Try it

Responses

201 Documents uploaded successfully

Documents uploaded successfully.

JSON
{
  "success": true,
  "message": "Documents uploaded successfully.",
  "data": [
    {
      "id": 18,
      "documentName": "Signed NDA.pdf",
      "documentPath": "string",
      "temporaryUrl": "string",
      "uploadedBy": "organization",
      "categories": [
        {
          "id": 3,
          "value": 3,
          "label": "Contracts",
          "isCustom": false
        }
      ],
      "tags": [
        {
          "id": 7,
          "value": 7,
          "label": "Onboarding",
          "isCustom": true
        }
      ],
      "createdAt": "string"
    }
  ]
}
Response fields (19)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Documents uploaded successfully..

dataarray of object
data[].idinteger

Example 18.

data[].documentNamestring

Example Signed NDA.pdf.

data[].documentPathstring or null

Stored object key.

data[].temporaryUrlstring or null

The stored object key, as sent today — not a presigned link.

data[].uploadedBystring

One of: organization, provider. Example organization.

data[].categoriesarray of object
data[].categories[].idinteger

Example 3.

data[].categories[].valueinteger

Example 3.

data[].categories[].labelstring

Example Contracts.

data[].categories[].isCustomboolean

Example false.

data[].tagsarray of object
data[].tags[].idinteger

Example 7.

data[].tags[].valueinteger

Example 7.

data[].tags[].labelstring

Example Onboarding.

data[].tags[].isCustomboolean

Example true.

data[].createdAtstring (date-time) or null
401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'handshakes:edit' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'handshakes:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation failed — documents is required.

JSON
{
  "success": false,
  "message": "Unable to save. Please check the highlighted fields",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Unable to save. Please check the highlighted fields.

errorsany or null

Details when the handler has them — a field-keyed object, a single string, or null.

codestring

Empty unless the handler sets one.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.