Get one partner case (backoffice mode)

GET

/v1/client/cases/{case_ref}

Returns one partner case with full status history.
case_ref accepts numeric internal id or public user_case_id (FLOW...).

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

API Key

Add parameter in header

X-API-SECRET

Example:

X-API-SECRET: ********************

Path Params

Responses

🟢200

application/json

Partner case details

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://devapi.immigraflow.com/v1/client/cases/' \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-SECRET: <api-key>'

Response Example

200 - Example 1

{
    "case": {
        "id": 0,
        "user_case_id": "string",
        "receipt_number": "string",
        "description": "string",
        "created_at": "2019-08-24T14:15:22.123Z",
        "last_checked": "2019-08-24T14:15:22.123Z",
        "active": true,
        "user": {
            "id": 0,
            "email": "user@example.com",
            "name": "string",
            "phone": "string",
            "status": "active",
            "preferred_language": "en"
        }
    },
    "status_updates": [
        {
            "id": 0,
            "status_code": "string",
            "status_description": "string",
            "form_type": "string",
            "detail_message": "string",
            "status_code_es": "string",
            "status_description_es": "string",
            "status_code_pt": "string",
            "status_description_pt": "string",
            "submitted_date": "2019-08-24T14:15:22.123Z",
            "modified_date": "2019-08-24T14:15:22.123Z",
            "history": [
                {}
            ],
            "timestamp": "2019-08-24T14:15:22.123Z",
            "notified": 0,
            "email_notify_status": "skipped",
            "whatsapp_notify_status": "skipped",
            "email_notify_attempts": 0,
            "whatsapp_notify_attempts": 0,
            "email_notify_last_error": "string",
            "whatsapp_notify_last_error": "string",
            "email_notify_sent_at": "2019-08-24T14:15:22.123Z",
            "whatsapp_notify_sent_at": "2019-08-24T14:15:22.123Z"
        }
    ],
    "update_count": 0
}

Modified at 2026-05-14 05:58:25

Create case for partner user (backoffice mode)

Verify login code and issue bearer token