--- title: "Create a Lead" method: POST path: "/" --- # Create a Lead `POST /` ## Request - Base URL: `https://api.tap.company/v3/lead` - URL: `https://api.tap.company/v3/lead/` - Auth: none required This is version 3 endpoint to create a lead and the newest. Use this key to call this API with success response sk_test_qdiChYK2reTf4AByvS8Wkx9H ## Request body - object - `country` string, required: Base country of the busines in ISO2 - `brand` object: Information about the brand associated with this lead - `name` object[]: Array representing the brand names in multiple languages. - `text` string, required: The brand name in a specific language. Must have a minimum of 3 characters. - `lang` string, required: The language code for the brand name (e.g., en, ar). - `logo` string: File ID for the brand logo. - `channel_services` object[]: Array of sales channels associated with this brand - `channel` string: The brand's sales channel. Accepted values are: Website, Twitter, Instagram, iOS, Android, Call center, Linkedin, Physical store - `address` string: The brand channel's address. - `segment` object: Information about the brand segment associated withj t - `type` object: Information about the specific business the brand operates within. - `code` string: The business segment type code, which must be one of the accepted values (e.g., "non_profit"). - `team` object: Information about the team responsible for managing the segment of the brand. - `code` string: The segment team size code, which must be one of the accepted values (e.g., small). - `terms` object[]: the terms details of the business - `term` string: The agreement type. Accepted values are: general, chargeback, refund - `agree` boolean: Boolean indicating if the term has been agreed to. - `operations` object - `users` object[]: Information about the user associated with this lead - `name` object[]: Information about the name associated with this lead - `lang` string: The language code for the user's name. - `title` string: The user's title (e.g., "Mr.", "Mrs."). - `first` string: The user's first name. - `middle` string: The user's middle name. - `last` string: The user's last name. - `contact` object: Information about the user's contact details associated with this lead - `email` object[]: Information about the user's emails associated with this lead - `address` string: The user's email address. - `primary` boolean: Boolean indicating if the email is primary. - `phone` object[]: Information about the user's phone numbers associated with this lead - `country_code` string: The user's phone country code - `number` string: user's phone number without the country code. - `primary` boolean: Boolean indicating if the phone number is primary. - `phone` object[]: Information about the user's phone details associated with this lead - `country_code` string: The user's phone country code - `number` string: user's phone number without the country code. - `primary` boolean: Boolean indicating if the phone number is primary. - `identification` object: Information about the user's identification associated with this lead. - `nationality` string: Specifies the user's nationality using two-character ISO code (e.g., SA for Saudi Arabia). - `number` string: The user's ID number. - `type` string: The user's identification type. valid values are: national_id, passport, iqamah, gcc_national_id - `country` string: Specifies the user's identification country using a two-character ISO code (e.g., SA for Saudi Arabia). - `birth` object: Information about the user's birth details associated with this lead. - `country` string: The country of the user's birth. - `city` string: The city of the user's birth. - `date` string: user's birth date in the format YYYY-MM-DD. - `primary` boolean: Boolean indicating if this user is the primary user. - `entity` object: Information about the entity associated with this lead - `legal_name` object[]: Information about the entity name associated with this lead. - `text` string: The legal name of the entity in a specific language. - `lang` string: The language code for the entity's legal name. - `tax` object: Information about the entity's tax associated with this lead. - `number` string: The Entity's tax number - `issuing_date` string, date: The Entity's tax issuing date in the format YYYY-MM-DD - `expiry_date` string: The entity tax's expiry date in the format YYYY-MM-DD - `documents` object[]: Information about the entity's tax documents associated with this lead. - `name` string: The tax document's name - `number` string: The tax document's number - `issuing_country` string: The tax document's issuing country in a 2-character ISO format - `issuing_date` string: The tax document's issuing date - `expiry_date` string: The tax document's expiry date - `images` string[]: The tax document's files. Extracted from the Files API - `carries_a_license` boolean: Indicates if the entity is licensed or not. - `license` object: Information about the entity license associated with this lead. - `number` string: The license number associated with the entity. - `country` string: The country where the license was issued. - `type` string: Indicates the license type; accepted values are Establishment, Trust, Partnership, LLC, JSC, Foreign JSC Branch, Mix LLC, Foreign LLC, GCC Partnership, GCC LLC, GCC JSC, Foreign LLC Branch, Profession LLC, and Freelancer. - `documents` object[]: Information about the entity's license documents associated with this lead. - `type` string: The type of document (e.g., "commercial_registration"). - `number` string: The license document number. - `issuing_country` string: The country where the document was issued. - `issuing_date` string: The issuing date of the license document in the format YYYY-MM-DD. - `expiry_date` string: The expiry date of the license document in the format YYYY-MM-DD. - `image` string: The file name of the uploaded license document. - `wallet` object: Information about the wallet associated with this lead - `currency` string: The currency of the wallet, which should be supported for the country (e.g., SAR,USD). - `country` string: The country where the wallet is based using a two-character ISO code.(e.g., "SA" for Saudi Arabia). - `name` object[]: Information about the wallet name associated with this lead. - `text` string: The wallet display name text. - `lang` string: The language code for the wallet display name. - `linked_financial_account` object: Information about the linked financial account associated with this lead. - `bank` object: Information about the linked account's bank associated with this lead. - `account` object: Information about the wallet is linked account associated with this lead. - `name` string: The name of the beneficiary. - `number` string: The bank account number. - `swift` string: The bank's SWIFT code. - `iban` string: The beneficiary's IBAN. - `brand` object: Information about the linked account's bank brand associated with this lead. - `name` object: Information about the linked account's bank brand - `text` string: The name of the bank in a specific language. - `lang` string: The language code for the bank's name. - `bank` object: Information about the bank associated with this lead. - `documents` object: Information about the wallet's bank documents associated with this lead. - `type` string: The document type for the bank statement or IBAN certificate (e.g., "bank_statement"). - `number` string: The document number for the bank statement or IBAN certificate. - `issuing_country` string: The issuing country of the bank document. - `issuing_date` string: The issuing date of the bank document. - `images` string: An array of uploaded files for the bank statement or IBAN certificate. - `merchant` object: Merchant platform and/or payment provider details - `payment_provider` object: Information about the payment provider associated with this brand - `technology` object: Object associated with the payment provider technology. - `id` string: The technology ID associated with this payment provider. - `institution` object: Object associated with the payment provider institution. - `id` string: The payment institution ID associated with this lead. - `development_house` object: Information about the development house associated with this lead. - `id` string: The development house ID associated with this lead. - `platforms` object[]: Information about the platforms associated with this lead. - `id` string: The platform ID linked to the lead. - `metadata` object: The set of key-value pairs that you can attach to an object. This can be useful for storing additional information in a structured format. - `udf` string - `post` object: The URL for posting updates - `url` string: Endpoint where connect will push the data to ## Response `200` 200 - object - `id` string - `brand` object - `name` object - `en` string - `ar` string - `logo` string - `operations` object - `sales` object - `period` string - `range` object - `from` string - `to` string - `currency` string - `channel_services` object[] - `channel` string - `address` string - `entity` object - `country` string - `is_licensed` boolean - `license` object - `number` string - `country` string - `type` string - `tax` object - `number` string - `issuing_date` string - `expiry_date` string - `wallet` object - `bank` object - `name` string - `account` object - `name` string - `number` string - `swift` string - `iban` string - `user` object - `name` object - `lang` string - `title` string - `first` string - `last` string - `nationality` string - `identification` object - `number` string - `type` string - `issuer` string - `birth` object - `country` string - `city` string - `date` string - `primary` boolean - `post` object - `url` string - `metadata` object - `param1` string - `reference_lead_id` string ## Other responses - `400`: 400 --- [API](https://skmtc.dev/tap/apis/lead-new.md) - [All operations](https://skmtc.dev/tap/apis/lead-new/llms.txt) - [OpenAPI document](https://skmtc.dev/tap/apis/lead-new/revisions/ef5f181f15b3?raw)