GEgetpaid
Applications

Create an application

Create an application initiated by the platform so the seller can start submitting their information. It can be:

  • onboarding: to create a new account for the seller and start accepting payments.
  • change_request: to update an existing seller account with new information.

Related webhooks:

  • application_submitted: sent when an application is submitted by a seller for review.
  • application_completed: sent when the application is approved and completed.
  • application_expired: sent when an application expires before it is submitted.
post/v2/applications

Request

Headers

Getpaid-Idempotency-Keystring required
Example:5c255194-30ec-11ed-a261-0242ac120002

A unique idempotency key to allow safe retrying. See Getpaid API idempotency for more details.

Request body

OR

Example request

{
  "reference": "ORD-202510-0232",
  "applicant": {
    "email": "jane.doe@company.com",
    "first_name": "Markus",
    "last_name": "Doe"
  },
  "business": {
    "legal_name": "Garage Germany AG",
    "country": "DE",
    "registered_address": {
      "line1": "Immermannstraße",
      "line2": "Haus 2, Wohnung 3A",
      "street_number": "40",
      "city": "Düsseldorf",
      "region": "Nordrhein-Westfalen",
      "postal_code": "40210"
    },
    "registration_number": {
      "type": "vat",
      "value": "DE123456789"
    }
  },
  "redirect": {
    "default": "https://titanauto.com/onboarding/complete?customer=53426"
  },
  "expires_in": "1.12:00",
  "webhooks": {
    "url": "https://webhooks.titanauto.com/getpaid"
  }
}

Response

Created

idstring 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.

referencestring required

An identifier in your system. It is recommended to make it unique but the uniqueness is not enforced by the solution.

created_atstring date-time required

UTC timestamp in ISO 8601 format with milliseconds (RFC 3339). Always includes the 'Z' UTC indicator.

updated_atstring date-time required

UTC timestamp in ISO 8601 format with milliseconds (RFC 3339). Always includes the 'Z' UTC indicator.

expires_atstring date-time required

UTC timestamp in ISO 8601 format with milliseconds (RFC 3339). Always includes the 'Z' UTC indicator.

Example response

{
  "id": "app_4fekhxdpss1et7rjp8t7rdpnw4",
  "reference": "ORD-202510-0232",
  "created_at": "2025-09-01T22:05:48.479Z",
  "updated_at": "2025-09-01T22:05:48.479Z",
  "expires_at": "2025-09-01T22:05:48.479Z",
  "account": {
    "id": "acc_44678r08jtm8zbt227tzhc4nw5"
  },
  "flow": {
    "next_step": {
      "expires_at": "2025-09-01T22:05:48.479Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.