GEgetpliant
Organizations

Create Organization

Changed on

Creates a new organization for onboarding via a partner integration.

post/organizations

Request

Headers

Idempotency-Keystring required

An opaque, unique string that identifies this request — any sufficiently random value (e.g. a UUID) is acceptable. Re-delivery of the same key for the same operation is a no-op. Reusing a key with a different request body returns 409. Follows the IETF HTTP API Working Group's Idempotency-Key specification: https://github.com/ietf-wg-httpapi/idempotency

Request body

namestring required

Legal entity name.

countrystring required

ISO 3166-1 alpha-2 country code.

currencystring required

ISO 4217 currency code.

legalFormstring required

Legal form of the entity. Use a value for the organization's country from Legal forms by country. Preserve the exact spelling, capitalization, spaces, and punctuation.

vatIdstring

VAT identification number.

tradeRegisterNumberstring required

Trade register number of the legal entity.

nationalRegisterCourtstring

National register court. Required for DE only.

foundationDatestring date required

Foundation date of the legal entity in ISO 8601 format (YYYY-MM-DD). Must be in the past.

partnerOrganizationIdstring required

Your permanent reference ID for this organization (e.g. your internal business customer ID). Stored verbatim, echoed back on all responses, and enforced as unique per partner — prevents logical duplicates across separate API calls. Distinct from the Idempotency-Key header, which handles network-level retry safety.

metadataobject

Arbitrary key-value pairs for storing additional information on this Pliant object. For your own use and reference.

Example request

{
  "name": "Sample GmbH",
  "country": "DE",
  "currency": "EUR",
  "billingAddress": {
    "country": "DE"
  },
  "legalForm": "GmbH",
  "vatId": "DE123456789",
  "tradeRegisterNumber": "HRB123456",
  "nationalRegisterCourt": "Amtsgericht München",
  "foundationDate": "2015-03-15",
  "partnerOrganizationId": "internal-123",
  "metadata": {
    "accountManagerEmail": "account.manager@org.de"
  },
  "leadData": {
    "yearlyRevenue": {
      "value": 5000000,
      "currency": "EUR"
    },
    "numberOfEmployees": 50,
    "plannedNumberOfCards": 20,
    "paymentFrequency": "MONTHLY",
    "expectedMonthlyTransactionVolume": {
      "value": 5000000,
      "currency": "EUR"
    },
    "customerAcquisitionChannel": "INBOUND",
    "customerRelationshipLength": 12
  }
}

Response

Created

idstring uuid

Pliant-assigned organization ID.

namestring
countrystring
currencystring
legalFormstring
vatIdstring
tradeRegisterNumberstring
nationalRegisterCourtstring
foundationDatestring date
accountGroupstring
accountType'CREDIT' | 'PREFUNDED'
partnerOrganizationIdstring
metadataobject
statusSchema (unresolved $ref)
createdAtstring date-time

Timestamp when the organization was created (ISO 8601).

Changes