---
title: "Get Customer Onboarding Request"
method: GET
path: "/v1/customers/{customerId}/onboarding-requests/{caseId}"
tags: ["Customer Onboarding"]
---

# Get Customer Onboarding Request

`GET /v1/customers/{customerId}/onboarding-requests/{caseId}`

## Request

- Base URL: `https://api.blockradar.co`
- URL: `https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/blockradar/apis/blockradar-documentation/docs/v1/customers/:customerId/onboarding-requests/:caseId/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the current onboarding case and requirements schema. Fetch this operation again when the case changes so the integration uses the current schema and status.

## Path parameters

- `customerId` string, uuid, required
- `caseId` string, uuid, required

## Response `200`

Customer onboarding request fetched.

- CustomerOnboardingRequestResponse
  - `statusCode` integer, required
  - `message` string, required
  - `data` CustomerOnboardingRequestData, required
    - `customerId` string, uuid, required
    - `case` CustomerOnboardingCase, required
      - `id` string, uuid, required
      - `businessId` string, uuid, required
      - `customerId` string, uuid, required
      - `providerId` string, uuid, required
      - `subjectType` 'customer', required
      - `status` 'draft' | 'collecting_information' | 'ready_for_submission' | 'submitted' | 'action_required' | 'pending_admin_review' | 'in_review' | 'approved' | 'rejected' | 'failed' | 'expired', required
      - `mode` 'api_only' | 'hosted_only' | 'hybrid' | 'manual', required
      - `feature` union
        - 'offramp' | 'onramp_payment_order' | 'onramp_virtual_account'
        - string
      - `providerReference` string, nullable
      - `routeIntent` object, nullable
      - `data` object, nullable
      - `hostedSessions` object[], nullable
      - `reason` string, nullable
      - `metadata` object, nullable
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
    - `requirements` CustomerOnboardingRequirements, required: Current customer-onboarding requirements. Provider identifiers are intentionally omitted.
      - `mode` 'api_only' | 'hosted_only' | 'hybrid' | 'manual', required
      - `subjectType` 'customer', required
      - `feature` union
        - 'offramp' | 'onramp_payment_order' | 'onramp_virtual_account'
        - string
      - `status` 'draft' | 'collecting_information' | 'ready_for_submission' | 'submitted' | 'action_required' | 'pending_admin_review' | 'in_review' | 'approved' | 'rejected' | 'failed' | 'expired', required
      - `schema` object, required: JSON Schema Draft 07 contract for the value submitted as `data`.

---

[API](https://skmtc.dev/blockradar/apis/blockradar-documentation.md) - [All operations](https://skmtc.dev/blockradar/apis/blockradar-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/blockradar/apis/blockradar-documentation/revisions/97f95b4cfc0d?raw)