Skip to main content
GET
/
entities
/
{entity_id}
Get Entity Onboarding Status
curl --request GET \
  --url https://api.meow.com/v1/entities/{entity_id} \
  --header 'x-api-key: <api-key>'
{
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "business_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "documents": [
    {
      "file_name": "<string>"
    }
  ],
  "next_step": {
    "missing": [
      "<string>"
    ],
    "can_submit": true,
    "required_proof_types": []
  }
}

Authorizations

​
x-api-key
string
header
required

Your Meow API key, sent in the x-api-key header for authentication.

Path Parameters

​
entity_id
string
required

Response

Successful Response

​
entity_id
string<uuid>
required

Public ID of the onboarded business entity, stable across the onboarding lifecycle and matching the entity_id used in the Customer API, MCP, and webhook payloads.

​
status
enum<string>
required

Current onboarding status.

Available options:
pending_document_upload,
pending_user_action,
submitted,
under_review,
approved,
rejected
​
business_name
string | null
required

Legal business name.

​
created_at
string<date-time>
required

ISO 8601 timestamp of when the entity was created.

​
updated_at
string<date-time>
required

ISO 8601 timestamp of when onboarding was last updated.

​
documents
OnboardingDocumentStatus · object[]
required

Documents uploaded during onboarding.

​
kyc_status
enum<string>
required

Identity verification status of the entity's primary representative. After you submit KYC data or the representative completes verification, this value moves to pending and resolves on its own; poll it to track progress. It is coarser than the identity_verification.* webhooks: a verification the webhooks report as identity_verification.action_required shows here as pending until a new attempt resolves.

Available options:
not_started,
pending,
approved,
rejected
​
onboarding_type
enum<string>
required

How this entity was onboarded (e.g. api, smb, partner).

Available options:
api,
smb,
mcp,
partner
​
next_step
OnboardingNextStep · object
required

What you must do next: the current onboarding step, the items still missing for it, and whether the application is ready to be submitted for review.