Skip to content

Lead create

| View as Markdown

This API is used to create enterprise leads, which include basic, company, business, bank, and signatory information. In the “signatory_info” section, you can add or update up to four signatories.

https://kraken.airpay.co.in/airpay/ms/leads/api/createlead
FieldTypeDescription
content-typeStringapplication/json (required)
affiliateTextWill be provided by Airpay (required)
checksumText$string = $param.self+ $header.code::$secret_key; sha256(<concate all values+SECRET KEY>); (required)
processor-keyTextWill be provided by airpay ( required)
FieldTypeRequiredDescription
fnameTextYesFirst Name (length 20)
lnameTextYesLast Name (length 20)
emailTextYesEmail Address (length 25)
phoneNumericYesMobile Number (length 10)
company_nameTextYesCompany Name (length 10)
company_addressTextNoCompany Address (length 30)
merchant_legal_nameTextYesLegal Name of Merchant (length 20)
company_websiteTextYesCompany Website (length 30)
company_cinTextNoCompany Identification Number (length 21)
company_annual_turnoverTextYesAnnual turnover of the company (length 10). Valid options: 0 - 1L, 1L - 5L, 5L - 25L, 25L - 50L, 50L - 1Cr, Above 1Cr
business_typeNumericYesBusiness Type (length 10). Valid options: 1 - Private Ltd Company, 2 - Partnership, 3 - Proprietorship, 4 - Clubs / Societies / Associations, 5 - Trusts, 6 - Others, 7 - Public Ltd Company, 8 - Limited Liability Partnership
business_categoryNumericYesBusiness category ID (length 10)
business_panTextYesBusiness PAN number (length 10)
business_gstinTextNoBusiness GST number (length 15)
business_addressTextNoBusiness address (length 30)
business_cityTextYesCity (length 20)
business_pincodeTextNoPincode (length 6)
business_stateTextYesState (length 20)
business_countryTextYesCountry (length 20)
bank_account_typeTextYesBank account type (length 10). Valid values: C - Current, S - Savings
bank_account_holder_nameTextYesBank account holder name (length 20)
bank_account_numberTextYesBank account number (length 20)
bank_ifsc_codeTextYesBank IFSC code (length 11)
signatory_nameTextYesFull name of the signatory (length 20)
signatory_emailTextYesEmail address of the signatory (length 20)
signatory_phoneNumericYesMobile number of the signatory (length 10)
signatory_addressTextNoAddress of the signatory (length 25)
signatory_pepTextYesIndicates whether the signatory is politically exposed (length 10)
signatory_dobDateYesDate of birth of the signatory in d-m-Y format (length 10)
signatory_panTextYesPAN number of the signatory (length 10)
signatory_primary_contactTextYesPrimary contact of the signatory (length 10)
signatory_address_proofTextYesAddress proof ID of the signatory (length 10)
signatory_pdconsentTextYesConsent for personal data storage by the signatory (length 10)
signatory_genderTextNoGender of the signatory (length 10)
{
"basic_info": {
"fname": "John",
"lname": "Doe",
"email":"johndoe1@example.com",
"phone":"1234567890"
},
"company_info": {
"company_name": "ABC Company",
"company_address": "123 Main St, City",
"merchant_legal_name": "ABC Legal Name",
"company_website": "http://www.exampleone.com",
"company_cin": "U00000AB0000CDE123456",
"company_annual_turnover": "Above 1Cr"
},
"business_info": {
"business_type": 1,
"business_category": 118,
"business_pan": "ABCDE1234F",
"business_gstin": "12ABCDE1234F1Z5",
"business_address": "Test Apartment",
"business_city": "Kochi",
"business_pincode": "123456",
"business_state": "Kerala",
"business_country": "India"
},
"bank_info": {
"bank_account_type": "C",
"bank_account_holder_name": "John Doe",
"bank_account_number": "1234567890",
"bank_ifsc_code": "ABCD1234567"
},
"signatory_info": {
"1": {
"signatory_name": "Signatory one",
"signatory_email": "signatoryone@example.com",
"signatory_phone": "1234567890",
"signatory_address": "123 Main St, City",
"signatory_pep": "N",
"signatory_dob": "01-01-1990",
"signatory_pan": "ABCDE1234G",
"signatory_primary_contact": "Y",
"signatory_address_proof" : "121",
"signatory_pdconsent" : "N",
"signatory_gender" : "F"
},
"2": {
"signatory_name": "Signatory two",
"signatory_email": "signatorytwo@example.com",
"signatory_phone": "1234567890",
"signatory_address": "Test Apartment",
"signatory_pep": "N",
"signatory_dob": "01-01-1990",
"signatory_pan": "ABCDE1235G",
"signatory_primary_contact": "N",
"signatory_address_proof" : "121",
"signatory_pdconsent" : "N",
"signatory_gender" : "m"
},
"3": {
"signatory_name": "Signatory three",
"signatory_email": "signatorythree@example.com",
"signatory_phone": "1234567890",
"signatory_address": "Test Apartment",
"signatory_pep": "N",
"signatory_dob": "11-01-1990",
"signatory_pan": "ABCDE1236G",
"signatory_primary_contact": "N",
"signatory_address_proof" : "122",
"signatory_pdconsent" : "Y",
"signatory_gender" : "f"
},
"4": {
"signatory_name": "Signatory four",
"signatory_email": "signatoryfour@example.com",
"signatory_phone": "1234567890",
"signatory_address": "Test Apartment",
"signatory_pep": "N",
"signatory_dob": "01-01-1990",
"signatory_pan": "ABCDE1230I",
"signatory_primary_contact": "Y",
"signatory_address_proof" : "124",
"signatory_pdconsent" : "N",
"signatory_gender" : "M"
}
}
}
curl --location 'https://kraken.airpay.co.in/airpay/ms/leads/api/createlead' \
--header 'Content-Type: application/json' \
--header 'AFFILIATE: s5018c4e6770be10ceb89171fd8a1b00' \
--header 'CHECKSUM: yda5100cf07619128fc1d384fbb79dbc4fc1b262fd50d4371019c9e6d28294b6' \
--header 'AIRPAYKEY: xvIvkudaKczCf8sapHZv5iadqzPEB9dPRvtLr4idn4SzmMjfuWgVvSsXEn==' \
--data '{
"query": "ydna195gdbpj7u2on87NRgYJbXc+JAS0y9As7D2txQ8VaF08lVO+tPCD4y40sfrBus/YnRED/+BkbY75l/NEw1yO0hj8UbmOONjkhfCz89I5baLbQVa+OZgAW7WKIBmFIPVd1xjaGkStlUIWvABJAExL1eohAtmBr9wHZ15DAEiPzRkOUl3azgh9p+KMondMY33G6VUkk5HjGNbc="
}'
FieldTypeDescription
statusNumeric400- fail,200-success(length 3)
messageTextsuccess, fail
dataTextJson response { “status”: status code, “message”: response message, “data”:[ {“parameter”:“array required data”}] }
{
"query": "rs89z04gcan1h7x3G+qX8aCygyzXZ7BF9VuHqP107HHJopgY8fnu00WKtrFhYP9dJp1PvI0WHtbw2MnyTPASISPgZXyIYk3r+5hDMPVA7dE4061VbmBO+yR9uqUUIBaC5TcXgwWzHzUyQQtYFyqCbo3JzHinLh61Ufjj/EjMnC+5MW3RMKhN7zKl8qVB2K0okkfX98VFe7/zWf+J6HstGcAD8+aGERIm/C8K+mZSJxuHpHKYxTDA6PI73xnRw="
}
{
"status": "200",
"message": "Success",
"data": {
"message": "Lead created successfully.",
"lead_id": 12345
}
}
{
"query": "akahsjkajd8aCygyzXZ7BF9VuHqP1aksjdak07HHJopgY8fnu00WKtrFhYP9dJp1PvI0WHtbw2MnyTPASISPgZXyIYk3r+5hDMPVA7dE4061VbmBO+yR9uqUUIBaC5Tc6JZmJksajkadjancawukjaalkalfalfasnkajlKldlKLSskkkkkueww="
}
{
"status": "400",
"message": "Failed",
"data": {
"error": ""
}
}