immiblox Public APIs

Required headers

• No auth headers required

Request body

Copy{
  "email": "user@example.com",
  "password": "SecurePassword123!"
}

Response example

Copy{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "account": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "user@example.com",
    "username": null,
    "auth_provider": "cognito",
    "created_at": "2025-01-15T10:00:00Z",
    "updated_at": "2025-01-15T10:00:00Z"
  },
  "message": "Account created successfully"
}

cURL example

Copycurl -X POST https://account.api.dev.immiblox.com/api/v1/auth/signup \
  -H "Content-Type: application/json" \
  -d '{"email":"user@example.com","password":"SecurePassword123!"}'

Required headers

• No auth headers required

Request body

Copy{
  "email": "user@example.com",
  "password": "SecurePassword123!"
}

Response example

Copy{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "account": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "user@example.com",
    "username": null
  }
}

cURL example

Copycurl -X POST https://account.api.dev.immiblox.com/api/v1/auth/signin \
  -H "Content-Type: application/json" \
  -d '{"email":"user@example.com","password":"SecurePassword123!"}'

Required headers

• No auth headers required

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/auth/signout",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://account.api.dev.immiblox.com/api/v1/auth/signout \
  -H "Content-Type: application/json" \
  -d '{"example":"value"}'

Required headers

• No auth headers required

Request body

Copy{
  "email": "user@example.com"
}

Response example

Copy{
  "message": "If an account with that email exists, a password reset link has been sent."
}

cURL example

Copycurl -X POST https://account.api.dev.immiblox.com/api/v1/auth/forgot-password \
  -H "Content-Type: application/json" \
  -d '{"email":"user@example.com"}'

Required headers

• No auth headers required

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/auth/reset-password",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://account.api.dev.immiblox.com/api/v1/auth/reset-password \
  -H "Content-Type: application/json" \
  -d '{"example":"value"}'

Required headers

• No auth headers required

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/auth/google",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://account.api.dev.immiblox.com/api/v1/auth/google \
  -H "Content-Type: application/json" \
  -d '{"example":"value"}'

Required headers

• No auth headers required

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/auth/discover",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://account.api.dev.immiblox.com/api/v1/auth/discover \
  -H "Content-Type: application/json" \
  -d '{"example":"value"}'

Required headers

• No auth headers required

Response example

Copy{
  "success": true,
  "path": "/api/v1/auth/cognito/google-url",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://account.api.dev.immiblox.com/api/v1/auth/cognito/google-url \

Required headers

• No auth headers required

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/auth/cognito/exchange",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://account.api.dev.immiblox.com/api/v1/auth/cognito/exchange \
  -H "Content-Type: application/json" \
  -d '{"example":"value"}'

Required headers

• No auth headers required

Response example

Copy{
  "success": true,
  "path": "/api/v1/auth/cognito/logout-url",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://account.api.dev.immiblox.com/api/v1/auth/cognito/logout-url \

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "user@example.com",
  "username": "johndoe",
  "auth_provider": "cognito",
  "created_at": "2025-01-15T10:00:00Z",
  "updated_at": "2025-01-15T10:00:00Z"
}

cURL example

Copycurl -X GET https://account.api.dev.immiblox.com/api/v1/account/me \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/account/change-password",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://account.api.dev.immiblox.com/api/v1/account/change-password \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/account/change-email",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://account.api.dev.immiblox.com/api/v1/account/change-email \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/account/change-username",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://account.api.dev.immiblox.com/api/v1/account/change-username \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/family-members",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://account.api.dev.immiblox.com/api/v1/family-members \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "success": true,
  "path": "/api/v1/family-members",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://account.api.dev.immiblox.com/api/v1/family-members \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• id — id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/family-members/{id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://account.api.dev.immiblox.com/api/v1/family-members/{id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• id — id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/family-members/{id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X PUT https://account.api.dev.immiblox.com/api/v1/family-members/{id} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• id — id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/family-members/{id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X DELETE https://account.api.dev.immiblox.com/api/v1/family-members/{id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "family_member_id": null,
  "family_member_name": null,
  "description": "Personal immigration documents"
}

Response example

Copy{
  "id": "vault-uuid",
  "name": "My Vault",
  "description": "Personal immigration documents",
  "created_at": "2025-01-15T10:00:00Z"
}

cURL example

Copycurl -X POST https://vault.api.dev.immiblox.com/api/v1/vaults \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID" \
  -d '{"description":"Personal immigration documents"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "vaults": [
    {
      "id": "vault-uuid",
      "name": "My Vault",
      "description": "Personal documents"
    }
  ]
}

cURL example

Copycurl -X GET https://vault.api.dev.immiblox.com/api/v1/vaults \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — UUID of the vault

Response example

Copy{
  "id": "vault-uuid",
  "name": "My Vault",
  "description": "Personal immigration documents",
  "created_at": "2025-01-15T10:00:00Z"
}

cURL example

Copycurl -X GET https://vault.api.dev.immiblox.com/api/v1/vaults/VAULT_ID \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — vault_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/{vault_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X PUT https://vault.api.dev.immiblox.com/api/v1/vaults/{vault_id} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — vault_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/{vault_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X DELETE https://vault.api.dev.immiblox.com/api/v1/vaults/{vault_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — vault_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/{vault_id}/activity",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://vault.api.dev.immiblox.com/api/v1/vaults/{vault_id}/activity \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/shared-with-me",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://vault.api.dev.immiblox.com/api/v1/vaults/shared-with-me \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — vault_id path parameter

Request body

Copy{
  "emails": ["recipient@example.com"],
  "permission": "view"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/{vault_id}/shares",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://vault.api.dev.immiblox.com/api/v1/vaults/{vault_id}/shares \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — vault_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/{vault_id}/shares",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://vault.api.dev.immiblox.com/api/v1/vaults/{vault_id}/shares \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — vault_id path parameter
• share_id — share_id path parameter

Request body

Copy{
  "emails": ["recipient@example.com"],
  "permission": "view"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/{vault_id}/shares/{share_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X PUT https://vault.api.dev.immiblox.com/api/v1/vaults/{vault_id}/shares/{share_id} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — vault_id path parameter
• share_id — share_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/{vault_id}/shares/{share_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X DELETE https://vault.api.dev.immiblox.com/api/v1/vaults/{vault_id}/shares/{share_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• share_token=<token> query param or X-Share-Token header

Path parameters

• token — Share token from the vault share link

Response example

Copy{
  "vault": { "id": "...", "name": "Shared Vault" },
  "permissions": ["view", "download"]
}

cURL example

Copycurl -X GET https://vault.api.dev.immiblox.com/api/v1/public/shared/SHARE_TOKEN

Required headers

• share_token=<token> query param or X-Share-Token header

Path parameters

• token — token path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/public/shared/{token}/documents",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://vault.api.dev.immiblox.com/api/v1/public/shared/{token}/documents \

Required headers

• share_token=<token> query param or X-Share-Token header

Path parameters

• token — token path parameter
• document_id — document_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/public/shared/{token}/documents/{document_id}/download-url",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://vault.api.dev.immiblox.com/api/v1/public/shared/{token}/documents/{document_id}/download-url \

Required headers

• share_token=<token> query param or X-Share-Token header

Path parameters

• token — token path parameter

Request body

Copymultipart/form-data:
  file: <binary>
  (optional) document_type_id: <uuid>

Response example

Copy{
  "success": true,
  "path": "/api/v1/public/shared/{token}/documents/upload",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://vault.api.dev.immiblox.com/api/v1/public/shared/{token}/documents/upload \

Required headers

• share_token=<token> query param or X-Share-Token header

Path parameters

• token — token path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/public/validate-token/{token}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://vault.api.dev.immiblox.com/api/v1/public/validate-token/{token} \

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/public/session/create",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://vault.api.dev.immiblox.com/api/v1/public/session/create \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "success": true,
  "path": "/api/v1/public/session/validate",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://vault.api.dev.immiblox.com/api/v1/public/session/validate \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — UUID of the target vault

Request body

Copymultipart/form-data:
  file: <binary>
  (optional) document_type_id: <uuid>

Response example

Copy{
  "document": {
    "id": "doc-uuid",
    "filename": "passport.pdf",
    "document_type_name": "Passport",
    "status": "processing"
  }
}

cURL example

Copycurl -X POST https://document.api.dev.immiblox.com/api/v1/vaults/VAULT_ID/documents/upload \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID" \
  -F "file=@/path/to/document.pdf"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — vault_id path parameter

Request body

Copymultipart/form-data:
  file: <binary>
  (optional) document_type_id: <uuid>

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/{vault_id}/documents/upload-batch",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://document.api.dev.immiblox.com/api/v1/vaults/{vault_id}/documents/upload-batch \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — UUID of the vault

Query parameters

• search (string) — Search documents by OCR text (case-insensitive)

Response example

Copy{
  "documents": [
    {
      "id": "doc-uuid",
      "filename": "passport.pdf",
      "document_type_name": "Passport",
      "status": "processed"
    }
  ]
}

cURL example

Copycurl -X GET "https://document.api.dev.immiblox.com/api/v1/vaults/VAULT_ID/documents?search=passport" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — vault_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/{vault_id}/documents/prefilter",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://document.api.dev.immiblox.com/api/v1/vaults/{vault_id}/documents/prefilter \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• document_id — UUID of the document

Response example

Copy{
  "document": {
    "id": "doc-uuid",
    "filename": "passport.pdf",
    "document_type_name": "Passport",
    "status": "processed",
    "metadata": { "expiration_date": "2030-01-15" }
  }
}

cURL example

Copycurl -X GET https://document.api.dev.immiblox.com/api/v1/documents/DOCUMENT_ID \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• document_id — document_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/documents/{document_id}/classify",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X PATCH https://document.api.dev.immiblox.com/api/v1/documents/{document_id}/classify \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• document_id — document_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/documents/{document_id}/reprocess",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://document.api.dev.immiblox.com/api/v1/documents/{document_id}/reprocess \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/documents/forward",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://document.api.dev.immiblox.com/api/v1/documents/forward \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• document_id — document_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/documents/{document_id}/download",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://document.api.dev.immiblox.com/api/v1/documents/{document_id}/download \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• document_id — document_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/documents/{document_id}/view",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://document.api.dev.immiblox.com/api/v1/documents/{document_id}/view \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• document_id — document_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/documents/{document_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X DELETE https://document.api.dev.immiblox.com/api/v1/documents/{document_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• document_id — document_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/documents/{document_id}/move",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://document.api.dev.immiblox.com/api/v1/documents/{document_id}/move \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — vault_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/{vault_id}/documents/metadata",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://document.api.dev.immiblox.com/api/v1/vaults/{vault_id}/documents/metadata \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• No auth headers required

Response example

Copy{
  "document_types": [
    { "id": "uuid", "code": "PASSPORT", "name": "Passport" },
    { "id": "uuid", "code": "I20", "name": "Form I-20" }
  ]
}

cURL example

Copycurl -X GET https://document.api.dev.immiblox.com/api/v1/document-types

Required headers

• No auth headers required

Path parameters

• id — id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/document-types/{id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://document.api.dev.immiblox.com/api/v1/document-types/{id} \

Required headers

• No auth headers required

Response example

Copy{
  "document_index": [
    { "code": "PASSPORT", "name": "Passport", "category": "identity" }
  ]
}

cURL example

Copycurl -X GET https://document.api.dev.immiblox.com/api/v1/document-index

Required headers

• No auth headers required

Path parameters

• code — code path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/document-index/{code}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://document.api.dev.immiblox.com/api/v1/document-index/{code} \

Required headers

• share_token=<token> query param or X-Share-Token header

Path parameters

• vault_id — vault_id path parameter

Request body

Copymultipart/form-data:
  file: <binary>
  (optional) document_type_id: <uuid>

Response example

Copy{
  "success": true,
  "path": "/api/v1/public/vaults/{vault_id}/documents/upload",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://document.api.dev.immiblox.com/api/v1/public/vaults/{vault_id}/documents/upload \

Required headers

• share_token=<token> query param or X-Share-Token header

Path parameters

• document_id — document_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/public/documents/{document_id}/download",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://document.api.dev.immiblox.com/api/v1/public/documents/{document_id}/download \

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — UUID of the vault

Request body

Copy{
  "query": "What is my passport expiration date?",
  "top_k": 5
}

Response example

Copy{
  "results": [
    {
      "document_id": "doc-uuid",
      "score": 0.92,
      "snippet": "...expiration date: 01/15/2030..."
    }
  ]
}

cURL example

Copycurl -X POST https://document.api.dev.immiblox.com/api/v1/vaults/VAULT_ID/semantic-search \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID" \
  -d '{"query":"passport expiration date","top_k":5}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "models": [
    { "id": "gpt-4", "name": "GPT-4" }
  ]
}

cURL example

Copycurl -X GET https://assistant.api.dev.immiblox.com/api/v1/models \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "success": true,
  "path": "/api/v1/prompts",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://assistant.api.dev.immiblox.com/api/v1/prompts \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• prompt_id — prompt_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/prompts/{prompt_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://assistant.api.dev.immiblox.com/api/v1/prompts/{prompt_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• prompt_id — prompt_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/prompts/{prompt_id}/use",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://assistant.api.dev.immiblox.com/api/v1/prompts/{prompt_id}/use \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "success": true,
  "path": "/api/v1/sources",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://assistant.api.dev.immiblox.com/api/v1/sources \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/improve-query",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://assistant.api.dev.immiblox.com/api/v1/improve-query \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — UUID of the vault

Request body

Copy{
  "question": "What documents do I need for Form I-765?",
  "conversation_id": "optional-conversation-uuid"
}

Response example

Copy{
  "answer": "Based on your vault, you'll need...",
  "sources": [
    { "document_id": "...", "filename": "i765-instructions.pdf" }
  ]
}

cURL example

Copycurl -X POST https://assistant.api.dev.immiblox.com/api/v1/vaults/VAULT_ID/ask \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID" \
  -d '{"question":"What documents do I need for I-765?"}'

# With organization API keys (machine auth):
curl -X POST https://assistant.api.dev.immiblox.com/api/v1/vaults/VAULT_ID/ask \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-App-Key: YOUR_APP_KEY" \
  -d '{"question":"What documents do I need for I-765?"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — vault_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/{vault_id}/ask-stream",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://assistant.api.dev.immiblox.com/api/v1/vaults/{vault_id}/ask-stream \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — vault_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/{vault_id}/auto-fill",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://assistant.api.dev.immiblox.com/api/v1/vaults/{vault_id}/auto-fill \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• vault_id — vault_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/vaults/{vault_id}/follow-ups",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://assistant.api.dev.immiblox.com/api/v1/vaults/{vault_id}/follow-ups \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/conversations",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://assistant.api.dev.immiblox.com/api/v1/conversations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "success": true,
  "path": "/api/v1/conversations",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://assistant.api.dev.immiblox.com/api/v1/conversations \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• id — id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/conversations/{id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://assistant.api.dev.immiblox.com/api/v1/conversations/{id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• id — id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/conversations/{id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X PATCH https://assistant.api.dev.immiblox.com/api/v1/conversations/{id} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• id — id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/conversations/{id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X DELETE https://assistant.api.dev.immiblox.com/api/v1/conversations/{id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "success": true,
  "path": "/api/v1/news",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://assistant.api.dev.immiblox.com/api/v1/news \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "success": true,
  "path": "/api/v1/news/categories",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://assistant.api.dev.immiblox.com/api/v1/news/categories \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "success": true,
  "path": "/api/v1/news/regions",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://assistant.api.dev.immiblox.com/api/v1/news/regions \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• article_id — article_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/news/{article_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://assistant.api.dev.immiblox.com/api/v1/news/{article_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Query parameters

• category (string) — Filter by workflow category
• include_inactive (boolean) — Include inactive workflows

Response example

Copy{
  "workflows": [
    { "name": "i9-verification", "description": "I-9 document verification", "category": "compliance" }
  ]
}

cURL example

Copycurl -X GET https://workflow.api.dev.immiblox.com/api/v1/workflows \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• workflow_name — Name of the workflow template

Response example

Copy{
  "name": "i9-verification",
  "steps": [...],
  "category": "compliance"
}

cURL example

Copycurl -X GET https://workflow.api.dev.immiblox.com/api/v1/workflows/i9-verification \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• workflow_name — Name of the workflow template

Request body

Copy{
  "vault_id": "vault-uuid",
  "initial_context": {}
}

Response example

Copy{
  "execution_id": "exec-uuid",
  "status": "running"
}

cURL example

Copycurl -X POST https://workflow.api.dev.immiblox.com/api/v1/workflows/i9-verification/execute \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID" \
  -d '{"vault_id":"VAULT_ID","initial_context":{}}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• execution_id — UUID of the workflow execution

Response example

Copy{
  "id": "exec-uuid",
  "status": "running",
  "current_step": {...}
}

cURL example

Copycurl -X GET https://workflow.api.dev.immiblox.com/api/v1/workflow-executions/EXECUTION_ID \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• execution_id — UUID of the workflow execution
• step_execution_id — UUID of the step to complete

Request body

Copy{
  "document_ids": ["doc-uuid"],
  "selected_option": "option-id",
  "text_input": "value"
}

Response example

Copy{
  "success": true,
  "next_step": {...}
}

cURL example

Copycurl -X POST https://workflow.api.dev.immiblox.com/api/v1/workflow-executions/EXEC_ID/steps/STEP_ID/complete \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID" \
  -d '{"document_ids":["doc-uuid"]}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• execution_id — UUID of the workflow execution
• step_execution_id — UUID of the AI step to execute

Response example

Copy{
  "success": true,
  "output": {...}
}

cURL example

Copycurl -X POST https://workflow.api.dev.immiblox.com/api/v1/workflow-executions/EXEC_ID/steps/STEP_ID/execute \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "workflows": [...]
}

cURL example

Copycurl -X GET https://workflow.api.dev.immiblox.com/api/v1/engine/workflows \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• workflow_id — workflow_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/engine/workflows/{workflow_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://workflow.api.dev.immiblox.com/api/v1/engine/workflows/{workflow_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "steps": [...]
}

cURL example

Copycurl -X GET https://workflow.api.dev.immiblox.com/api/v1/engine/steps \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "success": true,
  "path": "/api/v1/engine/policies",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://workflow.api.dev.immiblox.com/api/v1/engine/policies \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• policy_id — policy_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/engine/policies/{policy_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://workflow.api.dev.immiblox.com/api/v1/engine/policies/{policy_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "workflow_id": "workflow-uuid",
  "vault_id": "vault-uuid",
  "initial_context": "{}"
}

Response example

Copy{
  "success": true,
  "execution_id": "exec-uuid"
}

cURL example

Copycurl -X POST https://workflow.api.dev.immiblox.com/api/v1/engine/executions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID" \
  -d '{"workflow_id":"WORKFLOW_ID","vault_id":"VAULT_ID"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "success": true,
  "path": "/api/v1/engine/executions",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://workflow.api.dev.immiblox.com/api/v1/engine/executions \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• execution_id — UUID of the execution

Response example

Copy{
  "id": "exec-uuid",
  "status": "running",
  "workflow_id": "workflow-uuid"
}

cURL example

Copycurl -X GET https://workflow.api.dev.immiblox.com/api/v1/engine/executions/EXECUTION_ID \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-User-ID: YOUR_USER_ID"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• execution_id — execution_id path parameter
• step_execution_id — step_execution_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/engine/executions/{execution_id}/steps/{step_execution_id}/complete",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://workflow.api.dev.immiblox.com/api/v1/engine/executions/{execution_id}/steps/{step_execution_id}/complete \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• execution_id — execution_id path parameter
• step_execution_id — step_execution_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/engine/executions/{execution_id}/steps/{step_execution_id}/execute",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://workflow.api.dev.immiblox.com/api/v1/engine/executions/{execution_id}/steps/{step_execution_id}/execute \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• execution_id — execution_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/engine/executions/{execution_id}/pause",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://workflow.api.dev.immiblox.com/api/v1/engine/executions/{execution_id}/pause \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• execution_id — execution_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/engine/executions/{execution_id}/resume",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://workflow.api.dev.immiblox.com/api/v1/engine/executions/{execution_id}/resume \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• execution_id — execution_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/engine/executions/{execution_id}/cancel",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://workflow.api.dev.immiblox.com/api/v1/engine/executions/{execution_id}/cancel \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• execution_id — execution_id path parameter

Request body

Copy{
  "organization_id": "ORG_ID",
  "event_type": "document.uploaded",
  "payload": "{"document_id":"..."}"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/engine/executions/{execution_id}/events",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://workflow.api.dev.immiblox.com/api/v1/engine/executions/{execution_id}/events \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/engine/policies/evaluate",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://workflow.api.dev.immiblox.com/api/v1/engine/policies/evaluate \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/engine/policies/evaluate-expression",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://workflow.api.dev.immiblox.com/api/v1/engine/policies/evaluate-expression \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane@example.com"
}

Response example

Copy{
  "id": "person-uuid",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane@example.com",
  "created_at": "2025-01-15T10:00:00Z"
}

cURL example

Copycurl -X POST https://immigration.api.dev.immiblox.com/api/v1/persons \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"first_name":"Jane","last_name":"Doe","email":"jane@example.com"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "success": true,
  "path": "/api/v1/persons",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://immigration.api.dev.immiblox.com/api/v1/persons \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• person_id — person_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/persons/{person_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://immigration.api.dev.immiblox.com/api/v1/persons/{person_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• person_id — person_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/persons/{person_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X PATCH https://immigration.api.dev.immiblox.com/api/v1/persons/{person_id} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• person_id — person_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/persons/{person_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X DELETE https://immigration.api.dev.immiblox.com/api/v1/persons/{person_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• person_id — person_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/persons/{person_id}/statuses",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://immigration.api.dev.immiblox.com/api/v1/persons/{person_id}/statuses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• person_id — UUID of the person

Response example

Copy{
  "statuses": [
    {
      "id": "status-uuid",
      "status_type": "visa",
      "valid_from": "2024-01-01",
      "valid_until": "2026-01-01"
    }
  ]
}

cURL example

Copycurl -X GET https://immigration.api.dev.immiblox.com/api/v1/persons/PERSON_ID/statuses \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• status_id — status_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/statuses/{status_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://immigration.api.dev.immiblox.com/api/v1/statuses/{status_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• status_id — status_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/statuses/{status_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X PATCH https://immigration.api.dev.immiblox.com/api/v1/statuses/{status_id} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• status_id — status_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/statuses/{status_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X DELETE https://immigration.api.dev.immiblox.com/api/v1/statuses/{status_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• person_id — person_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/persons/{person_id}/compliance-summary",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://immigration.api.dev.immiblox.com/api/v1/persons/{person_id}/compliance-summary \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• person_id — person_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/persons/{person_id}/compliance-events",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://immigration.api.dev.immiblox.com/api/v1/persons/{person_id}/compliance-events \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• person_id — person_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/persons/{person_id}/compliance-events",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://immigration.api.dev.immiblox.com/api/v1/persons/{person_id}/compliance-events \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/import/persons",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://immigration.api.dev.immiblox.com/api/v1/import/persons \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/import/statuses",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://immigration.api.dev.immiblox.com/api/v1/import/statuses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• person_id — person_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/persons/{person_id}/documents",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://immigration.api.dev.immiblox.com/api/v1/persons/{person_id}/documents \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• person_id — person_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/persons/{person_id}/documents",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://immigration.api.dev.immiblox.com/api/v1/persons/{person_id}/documents \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://organization.api.dev.immiblox.com/api/v1/organizations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "organizations": [
    {
      "id": "org-uuid",
      "name": "Acme Corp",
      "created_at": "2025-01-15T10:00:00Z"
    }
  ]
}

cURL example

Copycurl -X GET https://organization.api.dev.immiblox.com/api/v1/organizations \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X PATCH https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}/members",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id}/members \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}/members",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id}/members \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter
• member_id — member_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}/members/{member_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X DELETE https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id}/members/{member_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}/machine-auth/service-accounts",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id}/machine-auth/service-accounts \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}/machine-auth/service-accounts",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id}/machine-auth/service-accounts \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter
• id — id path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}/machine-auth/service-accounts/{id}/deactivate",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id}/machine-auth/service-accounts/{id}/deactivate \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — UUID of the organization

Request body

Copy{
  "name": "Production API Key",
  "app_key_id": "app-key-uuid"
}

Response example

Copy{
  "id": "api-key-uuid",
  "name": "Production API Key",
  "key_prefix": "imm_...",
  "created_at": "2025-01-15T10:00:00Z"
}

cURL example

Copycurl -X POST https://organization.api.dev.immiblox.com/api/v1/organizations/ORG_ID/machine-auth/api-keys \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"name":"Production API Key","app_key_id":"APP_KEY_ID"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}/machine-auth/api-keys",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id}/machine-auth/api-keys \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter
• id — id path parameter

Request body

Copy{
  "name": "integration-key",
  "scopes": ["integration:access"]
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}/machine-auth/api-keys/{id}/revoke",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id}/machine-auth/api-keys/{id}/revoke \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter
• id — id path parameter

Request body

Copy{
  "name": "integration-key",
  "scopes": ["integration:access"]
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}/machine-auth/api-keys/{id}/rotate",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id}/machine-auth/api-keys/{id}/rotate \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter

Request body

Copy{
  "name": "app-key",
  "scopes": ["integration:access"]
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}/machine-auth/app-keys",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id}/machine-auth/app-keys \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}/machine-auth/app-keys",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id}/machine-auth/app-keys \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter
• id — id path parameter

Request body

Copy{
  "name": "app-key",
  "scopes": ["integration:access"]
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}/machine-auth/app-keys/{id}/revoke",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id}/machine-auth/app-keys/{id}/revoke \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• organization_id — organization_id path parameter
• id — id path parameter

Request body

Copy{
  "name": "app-key",
  "scopes": ["integration:access"]
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/organizations/{organization_id}/machine-auth/app-keys/{id}/rotate",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://organization.api.dev.immiblox.com/api/v1/organizations/{organization_id}/machine-auth/app-keys/{id}/rotate \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "url": "https://your-app.com/webhooks/immiblox",
  "events": ["document.uploaded", "vault.shared"]
}

Response example

Copy{
  "id": "webhook-uuid",
  "url": "https://your-app.com/webhooks/immiblox",
  "events": ["document.uploaded", "vault.shared"],
  "created_at": "2025-01-15T10:00:00Z"
}

cURL example

Copycurl -X POST https://webhook.api.dev.immiblox.com/api/v1/webhooks \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"url":"https://your-app.com/webhooks/immiblox","events":["document.uploaded","vault.shared"]}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Query parameters

• organization_id (string) required — Organization UUID

Response example

Copy{
  "success": true,
  "path": "/api/v1/webhooks",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://webhook.api.dev.immiblox.com/api/v1/webhooks \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• webhook_id — webhook_id path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/webhooks/{webhook_id}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X DELETE https://webhook.api.dev.immiblox.com/api/v1/webhooks/{webhook_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Query parameters

• organization_id (string) required — Organization UUID
• webhook_id (string) — Filter events by webhook ID

Response example

Copy{
  "success": true,
  "path": "/api/v1/events",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://webhook.api.dev.immiblox.com/api/v1/events \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Query parameters

• organization_id (string) required — Organization UUID
• webhook_id (string) — Filter events by webhook ID

Request body

Copy{
  "organization_id": "ORG_ID",
  "event_type": "document.uploaded",
  "payload": "{"document_id":"..."}"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/events",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://webhook.api.dev.immiblox.com/api/v1/events \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Response example

Copy{
  "tools": [
    {
      "name": "search_documents",
      "description": "Search documents in a vault"
    }
  ]
}

cURL example

Copycurl -X GET https://mcp.api.dev.immiblox.com/api/v1/mcp/tools \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• tool_name — tool_name path parameter

Response example

Copy{
  "success": true,
  "path": "/api/v1/mcp/tools/{tool_name}",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X GET https://mcp.api.dev.immiblox.com/api/v1/mcp/tools/{tool_name} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Path parameters

• tool_name — tool_name path parameter

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/mcp/tools/{tool_name}/execute",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://mcp.api.dev.immiblox.com/api/v1/mcp/tools/{tool_name}/execute \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/chat/message",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://mcp.api.dev.immiblox.com/api/v1/chat/message \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'

Required headers

• Authorization: Bearer <access_token>
• Content-Type: application/json (for JSON body)

Request body

Copy{
  "example": "See endpoint-specific docs for required fields"
}

Response example

Copy{
  "success": true,
  "path": "/api/v1/chat/message/stream",
  "note": "Example response. Shape varies by endpoint."
}

cURL example

Copycurl -X POST https://mcp.api.dev.immiblox.com/api/v1/chat/message/stream \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{"example":"value"}'