1. Cases
ImmigraFlow API
  • Check
    • Check case status
      POST
  • Users
    • Verify user email from clickable token link
      GET
    • List users
      GET
    • Create user
      POST
    • Resend email verification
      POST
    • CORS preflight for resend-verification
      OPTIONS
    • Get user
      GET
    • Update user
      PUT
    • Delete user (self-service)
      DELETE
  • Cases
    • List user cases
      GET
    • Create case
      POST
    • Get one case
      GET
    • Update case
      PUT
    • Delete monitored case
      DELETE
  • Webhooks
    • List webhooks
      GET
    • Create webhook
      POST
    • Get webhook
      GET
    • Update webhook
      PUT
    • Delete webhook
      DELETE
  • AUTH
    • Request end-user login code
      POST
    • Verify code
      POST
  • Client
    • Get authenticated partner profile
      GET
    • List partner users (backoffice mode)
      GET
    • Get partner user (backoffice mode)
      GET
    • List all partner cases (backoffice mode)
      GET
    • Update partner logo URL
      PUT
    • Create partner user (backoffice mode)
      POST
    • Resend email verification (backoffice)
      POST
    • CORS preflight
      OPTIONS
    • Update partner user (backoffice mode)
      PUT
    • Delete partner user (backoffice)
      DELETE
    • Create case for partner user (backoffice mode)
      POST
    • Get one partner case (backoffice mode)
      GET
  • Auth
    • Verify login code and issue bearer token
  • Schemas
    • ErrorEnvelope
    • CheckRequest
    • User
    • UserCreateRequest
    • ResendVerificationRequest
    • UserUpdateRequest
    • LoginCodeRequest
    • LoginCodeVerifyRequest
    • LoginVerifyResponse
    • CaseSummary
    • PartnerCaseSummary
    • CaseCreateRequest
    • CaseUpdateRequest
    • StatusUpdate
    • CaseDetailsResponse
    • PartnerCaseDetailsResponse
    • CheckResponse
    • Webhook
    • WebhookCreateRequest
    • WebhookUpdateRequest
    • Client
    • ClientLogoUpdateRequest
  1. Cases

Get one case

GET
/v1/users/{user_id}/cases/{case_ref}
Returns one case and status history.
case_ref accepts numeric internal id or public user_case_id (e.g. FLOW1234567).

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: ********************
or
Path Params

Responses

🟢200
application/json
Case details
Bodyapplication/json

🟠400BadRequest
🟠401Unauthorized
🟠404NotFound
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://devapi.immigraflow.com/v1/users//cases/' \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-SECRET: <api-key>'
Response 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",
            "preferred_language": "en",
            "email_verified_at": "2019-08-24T14:15:22.123Z",
            "notify_by_email": true,
            "notify_by_whatsapp": true,
            "status": "active",
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z"
        }
    },
    "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-06-04 01:14:25
Previous
Create case
Next
Update case
Built with