---
title: "Check Apple Retention Messaging Access"
method: POST
path: "/v2/retention-onboarding/apple-access/check"
tags: ["Retention Messaging Onboarding V2"]
---

# Check Apple Retention Messaging Access

`POST /v2/retention-onboarding/apple-access/check`

## Request body

- object
  - `application_id` string, required — Application ID for the onboarding action

## Response `200`

Success

- object
  - `object` 'retention_apple_access_check', required
  - `application_id` string, required — a string to be decoded into a number
  - `status` 'granted' | 'not_granted', required
  - `sandbox_realtime_url` string, nullable, required
  - `expected_realtime_url` string, required
  - `matches_expected` boolean, required
  - `message` string, nullable, required

## Other responses

- `400` — The request did not match the expected schema
- `401` — No API key was provided in the request
- `403` — The API key does not have permission to perform this action
- `404` — The requested resource was not found
- `429` — Too many requests have been made in a short period
- `500` — An unexpected error occurred on the server
- `502` — The upstream retention provider request failed

---

[API](https://skmtc.dev/superwall/apis/superwall-api-v2.md) · [All operations](https://skmtc.dev/superwall/apis/superwall-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/superwall/superwall-api-v2/revisions/e04f76c478af/schema)