Skip to main content
API docs by Redocly

Dimmi Public API (1.0.0)

Download OpenAPI specification:Download

Organisation-scoped Public API for Dimmi cases, people, and documents. Authenticate with Authorization: Bearer dk_live_<key_id>.<secret>. Configure webhooks in the Dimmi client portal under Admin → Developers.

cases

List cases in the organization

Common base for /api/v1/* views: API-key auth, throttle, JSON-only error envelope.

Authorizations:
ApiKeyAuth
query Parameters
case_kind
string

extension | family

category
string

immigration | social_security | relocation

certificate_type
string

a1 | s1

cursor
string

Pagination cursor.

external_reference
string

Filter by your own ID for the case.

jurisdiction
string
lifecycle_stage
string
needs_attention
string
ongoing
string
page_size
integer

Page size (max 100).

person_id
string
search
string
status
string

Filter by status. One of: biometrics, draft, in_progress, permit_acquired, permit_expired, permit_expires_soon, processing, ready_to_submit, submitted

updated_since
string

ISO-8601 timestamp; only cases updated since.

Responses

Response samples

Content type
application/json
{
  • "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  • "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  • "results": [
    ]
}

Create a case (typed JSON for client parity, or multipart contract upload)

Common base for /api/v1/* views: API-key auth, throttle, JSON-only error envelope.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "string",
  • "status": "string",
  • "type": "string",
  • "jurisdiction": "string",
  • "scheme_key": "string",
  • "display_number": "string",
  • "applicant": {
    },
  • "person_id": "string",
  • "company": {
    },
  • "permit": {
    },
  • "employment": {
    },
  • "assignment_id": "string",
  • "is_extension": true,
  • "parent_case_id": "string",
  • "linked_cases": [
    ],
  • "assignment": {
    },
  • "has_documents": true,
  • "external_reference": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve a single case

Common base for /api/v1/* views: API-key auth, throttle, JSON-only error envelope.

Authorizations:
ApiKeyAuth
path Parameters
case_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "string",
  • "status": "string",
  • "type": "string",
  • "jurisdiction": "string",
  • "scheme_key": "string",
  • "display_number": "string",
  • "applicant": {
    },
  • "person_id": "string",
  • "company": {
    },
  • "permit": {
    },
  • "employment": {
    },
  • "assignment_id": "string",
  • "is_extension": true,
  • "parent_case_id": "string",
  • "linked_cases": [
    ],
  • "assignment": {
    },
  • "has_documents": true,
  • "external_reference": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Complete the start-case wizard for a draft case

POST /api/v1/cases/{id}/complete — finish start-case wizard / Policy approvals.

Authorizations:
ApiKeyAuth
path Parameters
case_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "string",
  • "status": "string",
  • "type": "string",
  • "jurisdiction": "string",
  • "scheme_key": "string",
  • "display_number": "string",
  • "applicant": {
    },
  • "person_id": "string",
  • "company": {
    },
  • "permit": {
    },
  • "employment": {
    },
  • "assignment_id": "string",
  • "is_extension": true,
  • "parent_case_id": "string",
  • "linked_cases": [
    ],
  • "assignment": {
    },
  • "has_documents": true,
  • "external_reference": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List documents for a case

Common base for /api/v1/* views: API-key auth, throttle, JSON-only error envelope.

Authorizations:
ApiKeyAuth
path Parameters
case_id
required
string
query Parameters
cursor
string

The pagination cursor value.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

Upload a document to a case

Common base for /api/v1/* views: API-key auth, throttle, JSON-only error envelope.

Authorizations:
ApiKeyAuth
path Parameters
case_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "string",
  • "case_id": "string",
  • "type": "string",
  • "file_name": "string",
  • "mime_type": "string",
  • "size_bytes": "string",
  • "uploaded_at": "2019-08-24T14:15:22Z",
  • "download_url": "string",
  • "download_url_expires_at": "string"
}

Create short-term visitor cases (one per member)

Common base for /api/v1/* views: API-key auth, throttle, JSON-only error envelope.

Authorizations:
ApiKeyAuth

Responses

documents

Retrieve document metadata + signed download URL

Common base for /api/v1/* views: API-key auth, throttle, JSON-only error envelope.

Authorizations:
ApiKeyAuth
path Parameters
document_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "string",
  • "case_id": "string",
  • "type": "string",
  • "file_name": "string",
  • "mime_type": "string",
  • "size_bytes": "string",
  • "uploaded_at": "2019-08-24T14:15:22Z",
  • "download_url": "string",
  • "download_url_expires_at": "string"
}

Redirect (302) to a fresh presigned download URL

Issues a fresh presigned URL via 302 so partner integrations can download files.

Authorizations:
ApiKeyAuth
path Parameters
document_id
required
string

Responses

people

List people (employees) in the organisation

Common base for /api/v1/* views: API-key auth, throttle, JSON-only error envelope.

Authorizations:
ApiKeyAuth
query Parameters
cursor
string
page_size
integer
search
string

Responses

Response samples

Content type
application/json
{}

Retrieve a person

Common base for /api/v1/* views: API-key auth, throttle, JSON-only error envelope.

Authorizations:
ApiKeyAuth
path Parameters
person_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "string",
  • "email": "string",
  • "full_name": "string",
  • "job_title": "string",
  • "department": "string",
  • "nationality": "string",
  • "permits": [
    ],
  • "certificates": [
    ],
  • "cases": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}