---
title: "Get an application"
method: GET
path: "/v2/applications/{application_id}"
tags: ["Applications"]
---

# Get an application

`GET /v2/applications/{application_id}`

## Request

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

Retrieve details of an application by its ID. Both `onboarding` and `change_request` applications can be retrieved.

## Path parameters

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

## Response `200`

OK

- GetApplicationResponse
  - `id` string, id, required: The unique identifier of the onboarding application.
  - `status` 'initiated' | 'identity_verified' | 'submitted' | 'screened' | 'approved' | 'completed' | 'cancelled' | 'expired', required: The status of the onboarding application.
  - `reference` string: An identifier in your system. It is recommended to make it unique but the uniqueness is not enforced by the solution.
  - `account` object, required: The account associated with the application.
    - `id` string, id, required: The unique identifier of the account.
  - `business` BusinessResponse: The seller business details if known at the time of application retrieval.
    - `legal_name` string, required: The legal name of the business.
    - `country` string, country, required: The two-letter [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
    - `legal_structure` 'ca_private_corp' | 'ca_public_corp' | 'ca_non_profit': The legal structure of the business. **It is required to provide the legal structure of the business if the country of registration is Canada (CA).**
    - `registered_address` object: The registered address of the business.
      - `line1` string, required: The first line of the address.
      - `line2` string: The second line of the address.
      - `street_number` string, required: The number assigned to the building on the street. May include alphanumeric formatting such as "7A" or "12-14". street number.
      - `city` string, required: The city, town, municipality, or locality where the address is located.
      - `region` string: The administrative area such as region, province, state, or county.
      - `postal_code` string, required: The postal code, postcode, or ZIP code used for mail delivery.
    - `registration_number` union: The business' registration number. The registration number is validated based on the country of the business.
      - BaseRegistrationNumber: The company registration number.
        - `type` string, required: The type of registration number. See the list of supported [registration numbers per country](/integration/api/references/registration-numbers).
        - `value` string, required: The registration number. See the format for each registration number type in the [registration numbers list](/integration/api/references/registration-numbers).
      - GermanRegistrationNumber: The company registration number.
        - `type` string, required: The type of registration number. See the list of supported [registration numbers per country](/integration/api/references/registration-numbers).
        - `value` string, required: The registration number. See the format for each registration number type in the [registration numbers list](/integration/api/references/registration-numbers).
        - `registry` string, required: The Germany district court where the business is registered. See the [list of Germany registry courts](/integration/api/references/registration-numbers/germany-registry-courts).
  - `applicant` ApplicantResponse: The details of the person representing the seller that applied for the Getpaid account if known at the time of application retrieval.
    - `email` string, email, required: The applicant's email address.
    - `first_name` string: The applicant's first name.
    - `last_name` string: The applicant's last name.
  - `flow` ApplicationFlow: 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.
  - `created_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.
  - `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.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `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)