Lead document upload

This API is used to uploading and updating (Signatory/Company/Wet) KYC document.

POST

https://kraken.airpay.co.in/airpay/ms/leads/api/docUpload

Header

Field	Type	Description
content-type	String	application/json (required)
affiliate	Text	Will be provided by Airpay (required)
checksum	Text	$string = $param.self+ $header.code::$secret_key; sha256(<concate all values+SECRET KEY>); (required)
processor-key	Text	Will be provided by airpay ( required)

Parameter

Field	Type	Required	Description
lead_id	Text	Yes	User ID of the merchant (length 10)
document_type_id	Numeric	Yes*	Document type ID (length 10). Not required for wet document upload.
page_1	Text	Yes	Front page of the document. File should be in base64 encoded format (length 200)
page_2	Text	Yes	Back page of the document. File should be in base64 encoded format (length 200)
page_3	Text	No	Additional page if multiple pages are present. File should be in base64 encoded format (length 200)
page_4	Text	No	Additional page if multiple pages are present. File should be in base64 encoded format (length 200)

Request-Example (signatory_kyc):

{
"lead_id": "12345",
"signatory_kyc": {
  "1": {
    "document_type_id": "111",
    "page_1": "data:image/jpeg;base64,/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNreQABAAQAAABkAAD/4QNvaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLwA8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/PiA8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA1LjMtYzAxMSA2Ni4xNDU2NjEsIDIwMTIvMDIvMDYtMTQ6NTY6MjcgICAgICAgICI+IDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+IDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIiB4bWxuczpzdFJlZj0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL3NUeXBlL1Jlc291cmNlUmVmIyIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bXBNTTpPcmlnaW5hbERvY3VtZW50SUQ9InhtcC5kaWQ6QUY1QUVGMTk3NTE4RUMxMUFDRjFBRDc3OUI5OTE3OTUiLz4gPHJkZjpEZXNjcmlwdGlvbiBtZWRpYSBudW1iZXI6IG1ldGEtd2ViLTUwMjYtMTBlZC0wZTUwLTg5OTY0MzBmYzJlIiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/Pv/uAA5BZG9iZQBkwAAAAAH/In/2Q==",
    "page_2": "data:image/jpeg;base64,/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNreQABAAQAAABkAAD/4QNvaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLwA8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/PiA8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA1LjMtYzAxMSA2Ni4xNDU2NjEsIDIwMTIvMDIvMDYtMTQ6NTY6MjcgICAgICAgICI+IDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+IDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIiB4bWxuczpzdFJlZj0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL3NUeXBlL1Jlc291cmNlUmVmIyIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bXBNTTpPcmlnaW5hbERvY3VtZW50SUQ9InhtcC5kaWQ6QUY1QUVGMTk3NTE4RUMxMUFDRjFBRDc3OUI5OTE3OTUiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6NjIzRkNCQTUyMUNEMTFFQzgzRUNGNzNGMjUxRThBRUIiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6NjIzRkNCQTQyMUNEMTFFQzgzRUNGNzNGMjUxRThBRUIiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoV2luZG93cykiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDozRTJENEFBRTE4MUVFQzExQjdFMzlEMDA2NDE5NzMzRiIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDpBRjVBRUYxOTc1MThFQzExQUNGMUFENzc5Qjk5MTc5NSIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/Pv/uAA5BZG9iZQBkwAAAAAH/In/2Q==",
    "page_3": "",
    "page_4": ""
  }
}
}

Request-Example (company_kyc):

{
"lead_id": "12345",
"company_kyc": {
  "1": {
    "document_type_id": "222",
    "page_1": "data:image/jpeg;base64,/9j/yianmAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNreQABAAQAAABkAAD/4QNvaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLwA8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/PiA8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA1LjMtYzAxMSA2Ni4xNDU2NjEsIDIwMTIvMDIvMDYtMTQ6NTY6MjcgICAgICAgICI+IDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+IDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIiB4bWxuczpzdFJlZj0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL3NUeXBlL1Jlc291cmNlUmVmIyIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bXBNTTpPcmlnaW5hbERvY3VtZW50SUQ9InhtcC5kaWQ6QUY1QUVGMTk3NTE4RUMxMUFDRjFBRDc3OUI5OTE3OTUiLz4gPHJkZjpEZXNjcmlwdGlvbiBtZWRpYSBudW1iZXI6IG1ldGEtd2ViLTUwMjYtMTBlZC0wZTUwLTg5OTY0MzBmYzJlIiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/Pv/uAA5BZG9iZQBkwAAAAAH/In/2Q==",
    "page_2": "data:image/jpeg;base64,/9j/JsaQAYRXhpodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIiB4bWxuczpzdFJlZj0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL3NUeXBlL1Jlc291cmNlUmVmIyIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bXBNTTpPcmlnaW5hbERvY3VtZW50SUQ9InhtcC5kaWQ6QUY1QUVGMTk3NTE4RUMxMUFDRjFBRDc3OUI5OTE3OTUiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6NjIzRkNCQTUyMUNEMTFFQzgzRUNGNzNGMjUxRThBRUIiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6NjIzRkNCQTQyMUNEMTFFQzgzRUNGNzNGMjUxRThBRUIiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoV2luZG93cykiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDozRTJENEFBRTE4MUVFQzExQjdFMzlEMDA2NDE5NzMzRiIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDpBRjVBRUYxOTc1MThFQzExQUNGMUFENzc5Qjk5MTc5NSIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/Pv/uAA5BZG9iZQBkwAAAAAH/In/2Q==",
    "page_3": "",
    "page_4": ""
  }
}
}

Request-Example (wetdocument_kyc):

{
"lead_id": "12345",
"wetdocument_kyc": {
  "1": {
    "page_1": "data:application/pdf;base64,/9j/shjyianmAYRXh1yZGYtc3ludGF4LW5zIyI+IDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIiB4bWxuczpzdFJlZj0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL3NUeXBlL1Jlc291cmNlUmVmIyIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bXBNTTpPcmlnaW5hbERvY3VtZW50SUQ9InhtcC5kaWQ6QUY1QUVGMTk3NTE4RUMxMUFDRjFBRDc3OUI5OTE3OTUiLz4gPHJkZjpEZXNjcmlwdGlvbiBtZWRpYSBudW1iZXI6IG1ldGEtd2ViLTUwMjYtMTBlZC0wZTUwLTg5OTY0MzBmYzJlIiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/Pv/uAA5BZG9iZQBkwAAAAAH/In/2Q==",
    "page_2": "data:application/pdf;base64,/9j/sjsaQAYRsXhpZgAIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/PiA8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA1LjMtYzAxMSA2Ni4xNDU2NjEsIDIwMTIvMDIvMDYtMTQ6NTY6MjcgICAgICAgICI+IDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+IDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIiB4bWxuczpzdFJlZj0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL3NUeXBlL1Jlc291cmNlUQzExQjdFMzlEMDA2NDE5NzMzRiIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDpBRjVBRUYxOTc1MThFQzExQUNGMUFENzc5Qjk5MTc5NSIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/Pv/uAA5BZG9iZQBkwAAAAAH/In/2Q==",
    "page_3": "",
    "page_4": ""
  }
}
}

Request-Example (encrypted):

curl --location 'https://kraken.airpay.co.in/airpay/ms/leads/api/docUpload' \
--header 'Content-Type: application/json' \
--header 'AFFILIATE: s5018c4e6770be10ceb89171fd8a1b00' \
--header 'CHECKSUM: ysssdsds00cf07619128fc1d384fbb79dbc4fc1b262fd50d4371019c9e6d28294b6' \
--header 'AIRPAYKEY: xvIvkudaKczCf8sapHZv5iadqzPEB9dPRvtLr4idn4SzmMjfuWgVvSsXEn==' \
--data '{
"query": "v34WYbISGPr/iybDrHf7IOgcYvG5KC+S0yUEvvjPj1Iw4ikNoGyefQjzHGWDsgWKUwTE4lzTlAzLeZf6LYxfLxE1iiTXKfUMyFKdUx0WKX9hwvsm1gLZs7EbtUCR+zVQLCNRDrgqZslxi+GBTbSi2NGMWc/6CzfvWd15vCNWvEI3FZGlj534mNnGq0zGkqv/F0Qx1o9yRO+veHqHunzt72n7L4hp8taT/zvNTG1ioeul4cmzEi3pgbueg+9TEeEZhr5T2tHUjqETWG2328z2XCwTd1/ZRL6j8CBUxPxYTO+gXO+/AIECGWEdsYAW3ZJFqF4/6CeX3LoL3+d93m2e/UzOiPE5X7XEJQDMyiU6KjWYOnO3Be0vRVrRblbmiGO3RREc095BTmW4lblQGmstOtUTySCZ5ZMaKeRvMKtPKQ/qpd1FbYIBFw7aI+xnENasat4691TDiinZGfKnXFMi7LV/HhSM3PjVLg8xmBj9/tde0/Tdfj0KloPIHLXYEHelHhwe0ShvqtdibooE2YKMITLL2dLF0Q7rrXqu6T2YJciVQc4RBa6qJLspJMBDho4RIYJ6ZXsFGZCdwmyTlBYF3Lyk4tHsP3cLKZ0u2NsqmrAM/qcsI/k5t1m7taf/zwBt8FnZt2izfD2mjTmZayvOURtHgZB2yUQj6esq5yq/Tmcfm0Bp9rdpjrCRS+qz6mQqlUYAnoG4CPO+tj9ugmJcA4v0/HWq2YVaF+gPwHjL0D0lv27plBt/jA/nQisGgAquT/COQW+AlU96ZlBPnz0n9scm8TH2xOu9mCJ69UZ80fzAa3VkG/XhgZr2WFgb+iWzIQ6CfKV4YOs4V5PrgDC7p9L/v9dgpJw"
}'

Success 200

Field	Type	Description
status	Numeric	400- fail,200-success(length 3)
message	Text	success, fail
data	Text	Json response { “status”: status code, “message”: response message, “data”:[ {“parameter”:“array required data”}] }

Success-Response(encrypted):

{
    "query": "sajgdhajnajfyTPASISPgZXyIYk3r+5hDMPVA7dE4061VbmBOkjsaaaasdhajsuwaiusdan+yR9uaslkadkaqUUIBaC5Tc6JZmJqN6KXgwWzHzUyQQtYFyqCbasdklaldaso3wAeTFuhEpJKFaYXSz2MGmZkxF36fjMFNLaKQGBCMZvaifoadaodaOPM3QtHc4bcLa/w="
}

Success-Response(decrypted):

{
    "status": "200",
    "message": "success",
    "data": {
        "lead_id": "12345",
        "message": "File uploaded successfully."
    }
}

Error-Response(encrypted):

{
    "query": "VuHqP107HHJopgY8fnu00WKtrFhYP9dJp1PvI0WHtbw2MnyTPASISPgZXyIYk3r+5hDMPVA7dE4061VbmBO+yR9uqUUIBaC5Tc6JZmJqN6KXgwWzHzUyQQtYFyqCbo3wAeTFuhEpJKFaYXSz2MGmZkxF36fjMFNLaKQGBCMZvOPM3QtHc4bcLa/w="
}

Error-Response(decrypted):

{
    "status": "400",
    "message": "Failed",
    "data": {
        "error": {
            "lead_id": "12345",
            "message": ""
        }
    }
}