---
title: "Refresh an application"
method: POST
path: "/v2/applications/{application_id}/refresh"
tags: ["Applications"]
---

# Refresh an application

`POST /v2/applications/{application_id}/refresh`

## Request

- Base URL: `https://api.getpaid.io`
- URL: `https://api.getpaid.io/v2/applications/{application_id}/refresh`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.getpaid.io/oauth/token` scopes: `accounts:read_write`
- TypeScript: <https://skmtc.dev/getpaid/apis/getpaid-api/docs/v2/applications/:application_id/refresh/post.ts> (a function with typed inputs; its response is checked against the schema)

Renews the hosted application URL so the seller can continue the flow. Both `onboarding` and `change_request` applications can be refreshed.
The application's top-level `expires_at` remains unchanged. The refreshed URL is returned in `flow.next_step.url`; `flow.next_step.expires_at` is the URL's separate expiration date.
Only applications in `initiated`, `identity_verified`, or `submitted` status whose `expires_at` is still in the future can be refreshed. Other states or a past expiration date return `422`. Refreshing does not reactivate an expired application.

## Path parameters

- `application_id` string, id, required: The unique identifier of the onboarding application.

## Headers

- `Getpaid-Idempotency-Key` string, required

## Response `200`

OK

- RefreshApplicationResponse
  - `id` string, id, required: The unique identifier of the onboarding application.
  - `updated_at` string, date-time, required: UTC timestamp in ISO 8601 format with milliseconds ([RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)). Always includes the 'Z' UTC indicator.
  - `expires_at` string, date-time, required: UTC timestamp in ISO 8601 format with milliseconds ([RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)). Always includes the 'Z' UTC indicator.
  - `flow` ApplicationFlow, required: The flow required for the onboarding application to complete.
    - `next_step` object, required: The next step required to complete the flow.
      - `type` 'redirect', required: The type of the next step.
      - `url` string, uri, required: The URL to redirect the seller to complete the onboarding.
      - `expires_at` string, date-time: UTC timestamp in ISO 8601 format with milliseconds ([RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)). Always includes the 'Z' UTC indicator.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `409`: Conflict
- `422`: Invalid Parameters
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/getpaid/apis/getpaid-api.md) - [All operations](https://skmtc.dev/getpaid/apis/getpaid-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getpaid/apis/getpaid-api/revisions/458eae3d49ad?raw)