--- updatedAt: 2026-04-21T09:29:18.000Z agentTools: projectIndex: https://partner.getpliant.com/llms.txt --- # Provide Lead Provide a new customer lead to Pliant for a customer referred by you, the partner. This lead will be picked up by our Sales team and they will onboard the customer as a new organization to Pliant. The details depend on the specific agreement Pliant has with you, the partner. More details can be found in our [guides section](/docs/partner-customer-is-referred-to-pliant). # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "contact": { "name": "API Support", "email": "support@getpliant.com", "url": "https://www.getpliant.com" }, "title": "Pliant Partner API", "description": "Pliant Partner API", "version": "2.1.0", "license": { "name": "MIT", "url": "https://opensource.org/license/MIT" } }, "servers": [ { "url": "https://partner-api.getpliant.com/api", "description": "Pliant Production Server" }, { "url": "https://sandbox.partner-api.getpliant.com/api", "description": "Pliant Sandbox Server" }, { "url": "https://pci-api.getpliant.com", "description": "PCI Vault Production Server" }, { "url": "https://pci-sandbox.partner-api.getpliant.com", "description": "PCI Vault Sandbox Server" } ], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "java", "kotlin" ], "headers": [ { "key": "Pliant-API-Version", "value": "2.1.0" } ] }, "tags": [ { "name": "Misc", "description": "This tag is for miscellaneous operations" } ], "paths": { "/partner-management/lead": { "post": { "summary": "Provide Lead", "description": "Provide a new customer lead to Pliant for a customer referred by you, the partner. This lead will be picked up by our Sales team and they will onboard the customer as a new organization to Pliant. The details depend on the specific agreement Pliant has with you, the partner. More details can be found in our [guides section](/docs/partner-customer-is-referred-to-pliant).", "tags": [ "Misc" ], "operationId": "create-lead", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "required": [ "company" ], "properties": { "company": { "type": "object", "description": "The legal entity that is referred to Pliant.", "required": [ "name", "country", "city", "postalCode", "address" ], "properties": { "name": { "type": "string", "description": "Name of the legal entity." }, "tradeRegisterNumber": { "type": "string", "description": "Trade register number of the legal entity." }, "country": { "type": "string", "description": "Country name (e.g. Germany) where the legal entity is registered. The full list of valid countries can be found in our [guides section](/docs/partner-customer-is-referred-to-pliant).", "example": "Germany", "enum": [ "Albania", "Andorra", "Armenia", "Australia", "Austria", "Belarus", "Belgium", "Bosnia and Herzegovina", "Brazil", "Bulgaria", "Canada", "Cayman Islands", "Croatia", "Cyprus", "Czechia", "Denmark", "Estonia", "Finland", "France", "Germany", "Gibraltar", "Greece", "Holy See", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Ireland", "Israel", "Italy", "Japan", "Kosovo", "Latvia", "Liechtenstein", "Lithuania", "Luxembourg", "Malta", "Mexico", "Moldova", "Monaco", "Montenegro", "Morocco", "Netherlands", "New Zealand", "North Macedonia", "Norway", "Poland", "Portugal", "Republic of Korea", "Romania", "Russia", "San Marino", "Serbia", "Singapore", "Slovakia", "Slovenia", "South Africa", "Spain", "Sweden", "Switzerland", "Thailand", "Tunisia", "Türkiye", "Ukraine", "United Arab Emirates", "United Kingdom", "United States" ] }, "industry": { "$ref": "#/components/schemas/OrganizationCreate/properties/leadData/properties/industry" }, "postalCode": { "type": "string", "description": "Postal code where legal entity is registered." }, "city": { "type": "string", "description": "City where legal entity is registered." }, "address": { "type": "string", "description": "Address where legal entity is registered." }, "accountType": { "type": "string", "description": "If known, which card product is requested by customer. Either with credit line (`CREDIT`) or without credit line (`PREFUND`).", "enum": [ "CREDIT", "PREFUND" ] }, "yearlyRevenue": { "type": "integer", "description": "Estimated yearly revenue in EUR of referred legal entity." }, "numberOfEmployees": { "type": "integer", "description": "Number of employees of referred legal entity." }, "foundingYear": { "type": "integer", "description": "Founding year of referred legal entity." }, "plannedCreditLimit": { "type": "integer", "description": "If known, estimated monthly credit card limit in EUR that reffered legal entity will need." }, "plannedNumberOfCards": { "type": "integer", "description": "If known, estimated amount of virtual and/or physical credit cards that reffered legal entity will issue." }, "paymentFrequency": { "type": "string", "description": "If known, desired payment frequency. For prefund you are able to provide `PREFUND` as valid value", "enum": [ "MONTHLY", "BI-WEEKLY", "WEEKLY", "DAILY", "PREFUND" ] } } }, "contacts": { "type": "array", "nullable": true, "maxLength": 5, "items": { "type": "object", "description": "Who to contact for onboarding of this legal entity (max. 5 contacts).", "required": [ "firstName", "lastName", "email" ], "properties": { "salutation": { "type": "string", "description": "Salutation of contact person, can be `MRS` or `MR`.", "enum": [ "MR", "MRS" ] }, "firstName": { "type": "string", "description": "First name of contact person." }, "lastName": { "type": "string", "description": "Last name of contact person." }, "email": { "type": "string", "description": "Email address of contact person." }, "phone": { "type": "string", "description": "Phone number of contact person." }, "contactRole": { "type": "string", "description": "Role of the person within the legal entity. Those roles are a hint for our Sales team to know who to contact for onboarding. Only the legal representative (`LEGAL_REP`) can complete the onboarding process, for instance signing the terms and conditions. The `CONTACT` role is the default value for all other people, which are relevant for the onboarding but are not a legal representative of the company. Those people can later be assigned the common Pliant roles such as cardholder, accountant or admin.", "enum": [ "CONTACT", "LEGAL_REP" ], "default": "CONTACT" } } } }, "comment": { "type": "string", "description": "Any other important aspects to consider?" }, "partnersOrganizationId": { "type": "string", "deprecated": true, "description": "Unique identifier for customer/organization in your system. Used in various endpoints/callbacks to help you mapping Pliant organizationId accordingly." }, "partnerOrganizationId": { "type": "string", "description": "Unique identifier for customer/organization in your system. Used in various endpoints/callbacks to help you mapping Pliant organizationId accordingly." }, "partnerContact": { "type": "object", "description": "Contact person at the partner organization responsible for this lead.", "required": [ "name", "email" ], "properties": { "name": { "type": "string", "description": "Full name of the partner contact responsible for the lead." }, "email": { "type": "string", "description": "Email address of the partner contact." } } } } } ] } } } }, "responses": { "200": { "description": "Ok" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "This API uses oAuth2 with client credentials flow to [obtain the Bearer Token](/docs/authenticated-api-usage).", "bearerFormat": "JWT" } }, "schemas": { "OrganizationCreate": { "type": "object", "required": [ "name", "country", "currency", "billingAddress", "legalForm", "tradeRegisterNumber", "foundationDate", "partnerOrganizationId" ], "properties": { "name": { "type": "string", "maxLength": 255, "description": "Legal entity name.", "example": "Sample GmbH" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "ISO 3166-1 alpha-2 country code.", "example": "DE" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code.", "example": "EUR" }, "billingAddress": { "type": "object", "required": [ "streetName", "streetNumber", "postalCode", "city", "country" ], "properties": { "streetName": { "type": "string", "maxLength": 128, "description": "Street name." }, "streetNumber": { "type": "string", "maxLength": 128, "description": "Street number." }, "streetAdditional": { "type": "string", "maxLength": 128, "description": "Additional address line (e.g. apartment, floor)." }, "postalCode": { "type": "string", "maxLength": 16, "description": "Postal code. Validated against country-specific format." }, "city": { "type": "string", "maxLength": 64, "description": "City." }, "subdivisionCode": { "type": "string", "maxLength": 6, "description": "ISO 3166-2 subdivision code without the country prefix (e.g. `NY` for New York, US). Optional — recommended for US addresses.\n" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "ISO 3166-1 alpha-2 country code. Must match the top-level `country` field.", "example": "DE" } } }, "legalForm": { "type": "string", "maxLength": 128, "description": "Legal form of the entity. Use a value for the organization's `country` from\n[Legal forms by country](/docs/legal-forms-by-country).\nPreserve the exact spelling, capitalization, spaces, and punctuation.\n", "example": "GmbH" }, "vatId": { "type": "string", "description": "VAT identification number.", "example": "DE123456789" }, "tradeRegisterNumber": { "type": "string", "maxLength": 64, "description": "Trade register number of the legal entity.", "example": "HRB123456" }, "nationalRegisterCourt": { "type": "string", "description": "National register court. Required for DE only.", "example": "Amtsgericht München" }, "foundationDate": { "type": "string", "format": "date", "description": "Foundation date of the legal entity in ISO 8601 format (YYYY-MM-DD). Must be in the past.", "example": "2015-03-15" }, "partnerOrganizationId": { "type": "string", "maxLength": 128, "description": "Your permanent reference ID for this organization (e.g. your internal business customer ID). Stored verbatim, \nechoed back on all responses, and enforced as unique per partner — prevents logical duplicates across separate API calls. \nDistinct from the Idempotency-Key header, which handles network-level retry safety.\n", "example": "internal-123" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Arbitrary key-value pairs for storing additional information on this Pliant object.\nFor your own use and reference.\n", "example": { "accountManagerEmail": "account.manager@org.de" } }, "leadData": { "type": "object", "description": "Additional lead information used for sales qualification and CRM enrichment.", "required": [ "accountType", "customerAcquisitionChannel", "customerRelationshipLength", "contacts" ], "properties": { "accountType": { "type": "string", "description": "If known, which card product is requested by customer. Either with credit line (=credit) or without credit line (=prefund).", "enum": [ "CREDIT", "PREFUNDED" ] }, "industry": { "type": "string", "description": "Industry of the legal entity.", "enum": [ "ACCOUNTING", "AIRLINES_AVIATION", "ALTERNATIVE_DISPUTE_RESOLUTION", "ALTERNATIVE_MEDICINE", "ANIMATION", "APPAREL_FASHION", "ARCHITECTURE_PLANNING", "ARTS_AND_CRAFTS", "AUTOMOTIVE", "AVIATION_AEROSPACE", "BANKING", "BIOTECHNOLOGY", "BROADCAST_MEDIA", "BUILDING_MATERIALS", "BUSINESS_SERVICES", "BUSINESS_SUPPLIES_AND_EQUIPMENT", "CAPITAL_MARKETS", "CHEMICALS", "CIVIC_SOCIAL_ORGANIZATION", "CIVIL_ENGINEERING", "COMMERCIAL_REAL_ESTATE", "COMPUTER_GAMES", "COMPUTER_HARDWARE", "COMPUTER_NETWORK_SECURITY", "COMPUTER_NETWORKING", "COMPUTER_SOFTWARE", "CONSTRUCTION", "CONSUMER_ELECTRONICS", "CONSUMER_GOODS", "CONSUMER_SERVICES", "CONVENIENCE_STORES_GAS_STATIONS_LIQUOR_STORES", "COSMETICS", "DAIRY", "DEFENSE_SPACE", "DESIGN", "E_COMMERCE", "E_LEARNING", "EDUCATION_MANAGEMENT", "ELECTRICAL_ELECTRONIC_MANUFACTURING", "ENTERTAINMENT", "ENVIRONMENTAL_SERVICES", "EVENTS_SERVICES", "EXECUTIVE_OFFICE", "FACILITIES_SERVICES", "FARMING", "FINANCIAL_SERVICES", "FINE_ART", "FISHERY", "FOOD_BEVERAGES", "FOOD_PRODUCTION", "FUND_RAISING", "FURNITURE", "GAMBLING_CASINOS", "GLASS_CERAMICS_CONCRETE", "GOVERNMENT_ADMINISTRATION", "GOVERNMENT_RELATIONS", "GRAPHIC_DESIGN", "HEALTH_WELLNESS_AND_FITNESS", "HIGHER_EDUCATION", "HOSPITAL_HEALTH_CARE", "HOSPITALITY", "HUMAN_RESOURCES", "IMPORT_AND_EXPORT", "INDIVIDUAL_FAMILY_SERVICES", "INDUSTRIAL_AUTOMATION", "INFORMATION_SERVICES", "INFORMATION_TECHNOLOGY_AND_SERVICES", "INSURANCE", "INTERNATIONAL_AFFAIRS", "INTERNATIONAL_TRADE_AND_DEVELOPMENT", "INTERNET", "INVESTMENT_BANKING", "INVESTMENT_MANAGEMENT", "IT_SERVICE", "JUDICIARY", "LAW_ENFORCEMENT", "LAW_PRACTICE", "LEGAL_SERVICES", "LEGISLATIVE_OFFICE", "LEISURE_TRAVEL_TOURISM", "LIBRARIES", "LOGISTICS_AND_SUPPLY_CHAIN", "LUXURY_GOODS_JEWELRY", "MACHINERY", "MANAGEMENT_CONSULTING", "MARITIME", "MARKET_RESEARCH", "MARKETING_AND_ADVERTISING", "MECHANICAL_OR_INDUSTRIAL_ENGINEERING", "MEDIA_PRODUCTION", "MEDICAL_DEVICES", "MEDICAL_PRACTICE", "MENTAL_HEALTH_CARE", "MILITARY", "MINING_METALS", "MOTION_PICTURES_AND_FILM", "MUSEUMS_AND_INSTITUTIONS", "MUSIC", "NANOTECHNOLOGY", "NEWSPAPERS", "NON_PROFIT_ORGANIZATION_MANAGEMENT", "OIL_ENERGY", "ONLINE_MEDIA", "OUTSOURCING_OFFSHORING", "PACKAGE_FREIGHT_DELIVERY", "PACKAGING_AND_CONTAINERS", "PAPER_FOREST_PRODUCTS", "PERFORMING_ARTS", "PHARMACEUTICALS", "PHILANTHROPY", "PHOTOGRAPHY", "PLASTICS", "POLITICAL_ORGANIZATION", "PRIMARY_SECONDARY_EDUCATION", "PRINTING", "PROFESSIONAL_TRAINING_COACHING", "PROGRAM_DEVELOPMENT", "PUBLIC_POLICY", "PUBLIC_RELATIONS_AND_COMMUNICATIONS", "PUBLIC_SAFETY", "PUBLISHING", "RAILROAD_MANUFACTURE", "RANCHING", "REAL_ESTATE", "RECREATIONAL_FACILITIES_AND_SERVICES", "RELIGIOUS_INSTITUTIONS", "RENEWABLES_ENVIRONMENT", "RESEARCH", "RESTAURANTS", "RETAIL", "SECURITY_AND_INVESTIGATIONS", "SEMICONDUCTORS", "SHIPBUILDING", "SPORTING_GOODS", "SPORTS", "STAFFING_AND_RECRUITING", "SUPERMARKETS", "TELECOMMUNICATIONS", "TEXTILES", "THINK_TANKS", "TOBACCO", "TRANSLATION_AND_LOCALIZATION", "TRANSPORTATION", "TRANSPORTATION_TRUCKING_RAILROAD", "UTILITIES", "VENTURE_CAPITAL_PRIVATE_EQUITY", "VETERINARY", "WAREHOUSING", "WHOLESALE", "WINE_AND_SPIRITS", "WIRELESS", "WRITING_AND_EDITING" ] }, "yearlyRevenue": { "type": "object", "description": "Estimated yearly revenue.", "required": [ "value", "currency" ], "properties": { "value": { "type": "integer", "format": "int64", "description": "Amount in minor units (cents).", "example": 5000000 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code.", "example": "EUR" } } }, "numberOfEmployees": { "type": "integer", "description": "Number of employees of the referred legal entity.", "example": 50 }, "plannedNumberOfCards": { "type": "integer", "description": "Estimated number of virtual and/or physical credit cards the referred legal entity will issue.", "example": 20 }, "paymentFrequency": { "type": "string", "enum": [ "MONTHLY", "BI-WEEKLY", "WEEKLY", "DAILY", "PREFUNDED" ], "description": "Desired payment frequency. Use `PREFUNDED` for prefunded account types.\n", "example": "MONTHLY" }, "expectedMonthlyTransactionVolume": { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": "integer", "format": "int64", "description": "Amount in minor units (cents).", "example": 5000000 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 currency code.", "example": "EUR" } } }, "customerAcquisitionChannel": { "type": "string", "enum": [ "OUTBOUND", "INBOUND", "REFERRAL", "PARTNER", "CAMPAIGN" ], "description": "Channel through which the customer was acquired.", "example": "INBOUND" }, "customerRelationshipLength": { "type": "integer", "minimum": 0, "description": "Length of the existing relationship with the customer, in months.", "example": 12 }, "contacts": { "type": "array", "minItems": 1, "maxItems": 5, "description": "List of contact persons for the lead (relevant for HubSpot). Maximum 5 contacts.", "items": { "type": "object", "required": [ "firstName", "lastName", "email" ], "properties": { "salutation": { "type": "string", "enum": [ "MRS", "MR" ], "description": "Salutation of the contact person." }, "firstName": { "type": "string", "description": "First name of the contact person." }, "lastName": { "type": "string", "description": "Last name of the contact person." }, "email": { "type": "string", "format": "email", "description": "Email address of the contact person." }, "phone": { "type": "string", "description": "Phone number of the contact person." }, "contactRole": { "type": "string", "enum": [ "CONTACT", "LEGAL_REP" ], "default": "CONTACT", "description": "Role of the person within the legal entity.\n- `LEGAL_REP`: Legal representative; the only role that can complete onboarding (e.g. sign terms and conditions).\n- `CONTACT`: Default for all other relevant contacts who are not legal representatives.\n" } } } }, "comment": { "type": "string", "description": "Any additional context or notes to consider for this lead." }, "partnerContact": { "type": "object", "required": [ "name", "email" ], "properties": { "name": { "type": "string", "description": "Full name of the partner contact responsible for the lead." }, "email": { "type": "string", "format": "email", "description": "Email address of the partner contact." } } } } } } }, "Error": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "The error code" }, "exceptionId": { "type": "string", "format": "uuid", "description": "The id of the exception that was thrown" }, "message": { "type": "string", "description": "The cause of the error or further explanations on the error" } } } }, "responses": { "400": { "description": "Bad Request. The API consumer sent a malformed request which could not be processed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized. The API consumer is not authorized to access the requested resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden. The API consumer is not allowed to access the requested resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our [API guidelines](/docs/pliant-api-guidelines#api-rate-limits).", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Detailed description of the error and breached rate limit." } } } } } }, "500": { "description": "Internal Server Error. The request was not completed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "security": [ { "bearerAuth": [] } ] } ```