{"swagger":"2.0","info":{"description":"API to provide PAN and Bank Verification","version":"1.0.0","title":"AADHAARAPI KYC","contact":{"email":"contact@zoop.one"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"tags":[{"name":"PAN","description":"PAN Verification APIs"},{"name":"BANK VERIFICATION","description":"Bank Verification APIs"}],"paths":{"/pan":{"post":{"tags":["PAN"],"summary":"Performs PAN Verification","operationId":"panVerify","description":"Performs PAN Verification","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"header","name":"qt_api_key","description":"API key for the agency for respective Enviornment","required":true,"type":"string","format":"uuid"},{"in":"header","name":"qt_agency_id","description":"Agency ID","required":true,"type":"string","format":"uuid"},{"in":"body","name":"PanBody","description":"Pan number to be verified","schema":{"$ref":"#/definitions/PanBody"}}],"responses":{"200":{"description":"Validation Successful"},"400":{"description":"invalid input, object invalid"},"401":{"description":"Unauthorised Access"}}}},"/pan/fetch/{transactionId}":{"get":{"tags":["PAN"],"summary":"Serches PAN Transaction","operationId":"panFetch","description":"Returns Meta Information about a PAN Transaction\n","produces":["application/json"],"parameters":[{"in":"header","name":"qt_api_key","description":"API key for the agency for respective Enviornment","required":true,"type":"string","format":"uuid"},{"in":"header","name":"qt_agency_id","description":"Agency ID","required":true,"type":"string","format":"uuid"},{"in":"path","name":"transactionId","description":"Pass transaction ID whose Information needs to be fetched","required":true,"type":"string"}],"responses":{"200":{"description":"search results matching criteria","schema":{"type":"object","items":{"$ref":"#/definitions/PanFetchResult"}}},"400":{"description":"bad input parameter"},"401":{"description":"Unauthorised Access"}}}},"/pan-lite":{"post":{"tags":["PAN"],"summary":"Performs PAN Lite Verification","operationId":"panLiteVerify","description":"Performs PAN Lite Verification","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"header","name":"qt_api_key","description":"API key for the agency for respective Enviornment","required":true,"type":"string","format":"uuid"},{"in":"header","name":"qt_agency_id","description":"Agency ID","required":true,"type":"string","format":"uuid"},{"in":"body","name":"PanLiteBody","description":"Pan number to be verified","schema":{"$ref":"#/definitions/PanLiteBody"}}],"responses":{"200":{"description":"Validation Successful"},"400":{"description":"invalid input, object invalid"},"401":{"description":"Unauthorised Access"}}}},"/pan-lite/fetch/{transactionId}":{"get":{"tags":["PAN"],"summary":"Serches PAN Transaction","operationId":"panLiteFetch","description":"Returns Meta Information about a PAN Transaction\n","produces":["application/json"],"parameters":[{"in":"header","name":"qt_api_key","description":"API key for the agency for respective Enviornment","required":true,"type":"string","format":"uuid"},{"in":"header","name":"qt_agency_id","description":"Agency ID","required":true,"type":"string","format":"uuid"},{"in":"path","name":"transactionId","description":"Pass transaction ID whose Information needs to be fetched","required":true,"type":"string"}],"responses":{"200":{"description":"search results matching criteria","schema":{"type":"object","items":{"$ref":"#/definitions/PanFetchResult"}}},"400":{"description":"bad input parameter"},"401":{"description":"Unauthorised Access"}}}},"/verify-bank":{"post":{"tags":["BANK VERIFICATION"],"summary":"Performs BANK Verification","operationId":"bankVerify","description":"Performs BANK Verification","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"header","name":"qt_api_key","description":"API key for the agency for respective Enviornment","required":true,"type":"string","format":"uuid"},{"in":"header","name":"qt_agency_id","description":"Agency ID","required":true,"type":"string","format":"uuid"},{"in":"body","name":"BavBody","description":"Bank Account to be verified","schema":{"$ref":"#/definitions/BavBody"}}],"responses":{"200":{"description":"Validation Successful"},"400":{"description":"invalid input, object invalid"},"401":{"description":"Unauthorised Access"}}}},"/verify-bank/fetch/{transactionId}":{"get":{"tags":["BANK VERIFICATION"],"summary":"Serches PAN Transaction","operationId":"bavFetch","description":"Returns Meta Information about a BAV Transaction\n","produces":["application/json"],"parameters":[{"in":"header","name":"qt_api_key","description":"API key for the agency for respective Enviornment","required":true,"type":"string","format":"uuid"},{"in":"header","name":"qt_agency_id","description":"Agency ID","required":true,"type":"string","format":"uuid"},{"in":"path","name":"transactionId","description":"Pass transaction ID whose Information needs to be fetched","required":true,"type":"string"}],"responses":{"200":{"description":"search results matching criteria","schema":{"type":"object","items":{"$ref":"#/definitions/PanFetchResult"}}},"400":{"description":"bad input parameter"},"401":{"description":"Unauthorised Access"}}}}},"definitions":{"BavBody":{"type":"object","required":["Account","IFSC","Advance"],"properties":{"Account":{"type":"string","format":"numeric","example":1970108007322},"IFSC":{"type":"string","example":"CNRB0001970"},"Advance":{"type":"boolean","example":"Y"}}},"PanBody":{"type":"object","required":["pan"],"properties":{"pan":{"type":"string","example":"AJSPC9263A"}}},"PanLiteBody":{"type":"object","required":["pan","consent","consent_text"],"properties":{"pan":{"type":"string","example":"AJSPC9263A"},"consent":{"type":"boolean","example":"Y"},"consent_text":{"type":"string","example":"I hearby give my consent to verify my PAN for KYC purposes"}}},"PanFetchResult":{"type":"object","required":["id","response_code","env","pan_count","pan_success_count","transaction_status","consent","consent_text","request_timestamp","response_timestamp"],"properties":{"id":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851"},"response_code":{"type":"integer","example":1},"env":{"type":"integer","example":2},"pan_count":{"type":"integer","example":1},"pan_success_count":{"type":"integer","example":1},"transaction_status":{"type":"integer","example":1},"consent":{"type":"string","example":"N (not applicable for Pan Advance)"},"consent_text":{"type":"string","example":"null (not applicable for Pan Advance)"},"request_timestamp":{"type":"string","format":"date-time","example":"2019-12-23 11:25:23:562 +05:30"},"response_timestamp":{"type":"string","format":"date-time","example":"2019-12-23 11:25:24:099 +05:30"}}}},"host":"virtserver.swaggerhub.com","basePath":"/mohakZoop/AadhaarAPI/1.0.0","schemes":["https"]}