This API documentation is specific to being used as a companion with our web-app and not standalone. This documentation covers the integration process of creating batches using API's to the web-app version of Prudent AI and downloading the excel file of analysis generated. Webhook events are also available covering the batch status changes.
\nPost completion of batch processing, all functional analysis needs to be performed on the web-app only.
\nSend client_id and client_secret with grant_type client_credentials to Authentication service to obtain access_token for accessing APIs.
Access Token is valid for three hours and is required on all API Requests.
\nAs a best practice, use a single token for all calls. Assign a timestamp for each token, and then check the current timestamp before making any calls. If the token is greater than 150 minutes, generate a new one.
\nAfter five failed attempts to authenticate, your account will be locked. Contact support@prudent.ai to get help resetting your account.
\nUsers can upload the bank statements as individual PDF for each month or as one combined PDF file having all the months’ statements. Processor performs the QC of the bank statement based on individual month totals represented in the statement.
\nTo perform the QC for the combined statements, the processor splits the combined PDF file into individual months’ statements, as a new PDF. The filename of the new PDF consists of the original file name with the page numbers appended (for ex. “Filename_#Batch ID_page_1_4.pdf”).
\nThe results/status, including the transaction data are also updated for each of the individual files split by the processor.
\nProcessing Plaid Statements
\nIn addition to bank statements, users can also upload Plaid reports for processing. In case of a Plaid PDF report, the statements can be uploaded using the \"Create a Batch\" endpoint and follow the steps mentioned in \"Quick Start\" section.
\nIn case the Plaid report is available as a JSON, the reports need to be uploaded using the \"Plaid Json\" endpoint. No further action is required and once processing is complete, the results can be accessed.
\nNote: A batch with Plaid reports cannot be updated along with bank statements. Updates, if required on the batch can only be added as Plaid reports.
\nPrudent AI also provides a Python snippet for ease of usage - you can obtain the python script during the onboarding process. Which covers below steps.
\nStep 1: Get API access credentials by contacting contactus@prudent.ai.
\nclient_id and client_secret along with Prudent-API-KeyStep 2: Get Access Token by making request to Get Token endpoint using credentials acquired to access every other APIs.
\nStep 3: Create a Batch specifying Batch name and file names that will be uploaded to this batch.
\nIn case of Plaid Json reports, use the \"Plaid Json\" endpoint. Step 4 and Step 5 can be skipped.
\nStep 4: Upload files 1 by 1 using Upload File endpoint directly to s3 bucket based on credentials obtained from create batch request.
\nStep 5: After uploading required files for the batch initiate processing by invoking Process Batch endpoint
\nStep 6: Check the status of the Batch by invoking Get Quick Analysis endpoint
\nOnce all the files finish processing, the status of each file is updated, and the results are generated.
\nThe analysis excel file will be generated only for batches in the PROCESSED status.
\nThe output of this endpoint is intended for manual review, as opposed to automated consumption by your application.
\nGetting the spreadsheet output
\nThe analysis can also be downloaded in a spreadsheet format using the Get Analysis Excel File.
\nRequest Error Codes
\n404 - Content or URL not found
\n422 - If request has unsupported or incorrect params
\n401 - Authentication Failure
\n403 - No access to particular resource with current privileges
\n500 - Unexpected error at server side.
\nSend client_id and client_secret with grant_type client_credentials to Authentication service to obtain access_token for accessing APIs.
Access Token is valid for three hours and is required on all API Requests.
\nAs a best practice, use a single token for all calls. Assign a timestamp for each token, and then check the current timestamp before making any calls. If the token is greater than 150 minutes, generate a new one.
\nAfter five failed attempts to authenticate, your account will be locked. Contact support@prudent.ai to get help resetting your account.
\nRequired
\n","type":"file","value":null}]},"url":"https://bucket-url.s3.amazonaws.com/","description":"URL for upload will be available in the create batch API response.
\nNote:
Only PDF files are supported. Better results are achieved if the PDF is of high quality and relatively less skew or smudged.
This API is to be used to trigger processing of the Batch
\nBy passing the batch_id we initiate the queue to start processing the batch immediately. If not invoked immediately, it gets queued in 10min intervals.
This API provides the excel spreadsheet generated for the loan.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","name":"Prudent AI API Documentation","type":"collection"}},"urlObject":{"path":["batch",":batchId","analysis","download"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"id":"2cb92b42-3af9-4129-8d38-6710d554cf0b","type":"any","value":"1","key":"batchId"}]}},"response":[{"id":"fb9c1686-5cc2-45e0-8fad-300e2fb7ee7c","name":"Get Analysis Excel File","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BASE_URL}}/batch/:batchId/analysis/download","host":["{{BASE_URL}}"],"path":["batch",":batchId","analysis","download"],"variable":[{"key":"batchId","value":"1556"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Apr 2024 12:17:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"allow","value":"GET, OPTIONS"},{"key":"referrer-policy","value":"same-origin"},{"key":"set-cookie","value":"sessionid=q0i8pjab7bfxedk7sr6vm2qbik2jv45v; expires=Mon, 08 Apr 2024 12:32:14 GMT; HttpOnly; Max-Age=900; Path=/; SameSite=Lax; Secure"},{"key":"strict-transport-security","value":"max-age=900; includeSubDomains; preload"},{"key":"vary","value":"Accept, Authorization, Origin, Cookie"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"87123164ae587f9b-MAA"},{"key":"Content-Encoding","value":"gzip"},{"key":"Cf-Team","value":"1f5f3d32e300007f9b6db07400000001"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"uri\": \"https://nqm-staging.s3.amazonaws.com/useruploads/.......\",\n \"name\": \"Demo.xlsx\"\n },\n \"success\": true\n}"}],"_postman_id":"75af55ce-bb32-48ae-af2f-6ba727bc55e9"},{"name":"Get Quick Analysis","id":"e689c2c1-d2da-4059-9aab-f71079e1019a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/batch/:batchId/quick-analysis","description":"This API provides the a quick summary of the loan
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","name":"Prudent AI API Documentation","type":"collection"}},"urlObject":{"path":["batch",":batchId","quick-analysis"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"type":"any","value":"1","key":"batchId"}]}},"response":[{"id":"59b2e167-3edd-42b4-83ac-5f50f6d744dd","name":"Get Quick Analysis","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BASE_URL}}/batch/:batchId/analysis/quick_analysis","host":["{{BASE_URL}}"],"path":["batch",":batchId","analysis","quick_analysis"],"variable":[{"key":"batchId","value":"1556"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Apr 2024 12:17:14 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"allow","value":"GET, OPTIONS"},{"key":"referrer-policy","value":"same-origin"},{"key":"set-cookie","value":"sessionid=q0i8pjab7bfxedk7sr6vm2qbik2jv45v; expires=Mon, 08 Apr 2024 12:32:14 GMT; HttpOnly; Max-Age=900; Path=/; SameSite=Lax; Secure"},{"key":"strict-transport-security","value":"max-age=900; includeSubDomains; preload"},{"key":"vary","value":"Accept, Authorization, Origin, Cookie"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"87123164ae587f9b-MAA"},{"key":"Content-Encoding","value":"gzip"},{"key":"Cf-Team","value":"1f5f3d32e300007f9b6db07400000001"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"monthly_income\": 10747.72,\n \"qualified_income\": 5373.86,\n \"account_numbers\": \"#CH_x956944149\",\n \"period_start_date\": \"5-30-2019\",\n \"period_end_date\": \"5-29-2019\",\n \"count_of_months\": 2,\n \"missing_month\": [\n \"Jan-2022\",\n \"Feb-2022\"\n ],\n \"failures\": [\n {\n \"filename\": \"filename.pdf\",\n \"error_code\": \"MISSING_PAGES\"\n }\n ],\n \"accounts\": [\n {\n \"account_number\": \"acc-1\",\n \"account_class\": \"Business\"\n }\n ]\n },\n \"success\": true\n}"}],"_postman_id":"e689c2c1-d2da-4059-9aab-f71079e1019a"}],"id":"42fe5121-0ea8-417b-9ab0-af7abe01c9d8","_postman_id":"42fe5121-0ea8-417b-9ab0-af7abe01c9d8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","name":"Prudent AI API Documentation","type":"collection"}}},{"name":"Webhook","item":[{"name":"Register webhook","id":"e25af83e-58b7-47d7-bdf6-49b603cce18d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"https://domain-name.com/ddc72472-b829-48d4-9b04-85e383bee636\", // A Valid Url accepting POST requests\n \"secret\": \"wbsecTzllWqMvkZe80iY2nqiHR49qzcGs9ZLE\", // Min length 32 max lenght 128\n \"topics\": [\n \"Batch::PROCESSED\",\n \"Batch::FAILED\",\n \"Batch::PROCESSING_MANUALLY\"\n ] // one or many of the topics can be subscribed, recommended subscription to all\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/notifications/webhook","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","name":"Prudent AI API Documentation","type":"collection"}},"urlObject":{"path":["notifications","webhook"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"8c8a830c-fd91-422a-b800-566980278ba9","name":"Registration success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"https://domain-name.com/ddc72472-b829-48d4-9b04-85e383bee636\",\n \"secret\": \"wbsecTzllWqMvkZe80iY2nqiHR49qzcGs9ZLE\",\n \"topics\": [\n \"Batch::PROCESSED\",\n \"Batch::FAILED\",\n \"Batch::PROCESSING_MANUALLY\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/notifications/webhook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Apr 2024 10:27:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"referrer-policy","value":"same-origin"},{"key":"set-cookie","value":"sessionid=q1qxk3bkeok040c9d0xfr8icf57neykm; expires=Mon, 08 Apr 2024 10:42:39 GMT; HttpOnly; Max-Age=900; Path=/; SameSite=Lax; Secure"},{"key":"strict-transport-security","value":"max-age=900; includeSubDomains; preload"},{"key":"vary","value":"Accept, Authorization, Origin, Cookie"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"871190e5fccf7f9b-MAA"},{"key":"Content-Encoding","value":"gzip"},{"key":"Cf-Team","value":"1f5ed8e3b200007f9b66a28400000001"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"url\": \"https://domain-name.com/ddc72472-b829-48d4-9b04-85e383bee636\",\n \"active\": true,\n \"uuid\": \"wbsecTzllWqMvkZe80iY2nqiHR49qzcGs9ZLE\",\n \"topics\": [\n \"Batch::PROCESSING_MANUALLY\",\n \"Batch::FAILED\",\n \"Batch::PROCESSED\"\n ],\n \"created\": \"2024-02-08T10:27:39.162223Z\",\n \"modified\": \"2024-02-08T10:27:39.162244Z\"\n },\n \"success\": true\n}"},{"id":"aa3cf9d2-075d-4a80-8c09-07773a693b80","name":"Missing required info","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"https://domain-name.com/ddc72472-b829-48d4-9b04-85e383bee636\",\n \"secret\": \"wbsecTzllWqMvkZe80iY2nqiHR49qzcGs9ZLE\",\n \"topics\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/notifications/webhook"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Apr 2024 11:18:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"68"},{"key":"Connection","value":"keep-alive"},{"key":"allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"referrer-policy","value":"same-origin"},{"key":"set-cookie","value":"sessionid=9cm8q29b62xozj9fxycheiyh7kzczk0r; expires=Mon, 08 Apr 2024 11:33:27 GMT; HttpOnly; Max-Age=900; Path=/; SameSite=Lax; Secure"},{"key":"strict-transport-security","value":"max-age=900; includeSubDomains; preload"},{"key":"vary","value":"Accept, Authorization, Origin, Cookie"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8711db539fd07f9b-MAA"},{"key":"Cf-Team","value":"1f5f07683700007f9b6a7ad400000001"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"errors\": [\n \"Required attributes missing\"\n ],\n \"success\": false\n}"}],"_postman_id":"e25af83e-58b7-47d7-bdf6-49b603cce18d"},{"name":"List webhooks","id":"fea962e5-44d2-45d3-9bfd-91bf5b0350ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/notifications/webhook","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","name":"Prudent AI API Documentation","type":"collection"}},"urlObject":{"path":["notifications","webhook"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"5e052606-073a-4794-a153-5140c68ddff1","name":"Webhooks List","originalRequest":{"method":"GET","header":[],"url":"{{BASE_URL}}/notifications/webhook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Apr 2024 10:24:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"referrer-policy","value":"same-origin"},{"key":"set-cookie","value":"sessionid=q1qxk3bkeok040c9d0xfr8icf57neykm; expires=Mon, 08 Apr 2024 10:39:52 GMT; HttpOnly; Max-Age=900; Path=/; SameSite=Lax; Secure"},{"key":"strict-transport-security","value":"max-age=900; includeSubDomains; preload"},{"key":"vary","value":"Accept, Authorization, Origin, Cookie"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"87118cd12ddd7f9b-MAA"},{"key":"Content-Encoding","value":"gzip"},{"key":"Cf-Team","value":"1f5ed656b800007f9b66632400000001"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"url\": \"https://domain-name.com/ddc72472-b829-48d4-9b04-85e383bee636\",\n \"active\": true,\n \"uuid\": \"wbsecTzllWqMvkZe80iY2nqiHR49qzcGs9ZLE\",\n \"topics\": [\n \"Batch::PROCESSING_MANUALLY\",\n \"Batch::FAILED\",\n \"Batch::PROCESSED\"\n ],\n \"created\": \"2024-02-08T10:27:39.162223Z\",\n \"modified\": \"2024-02-08T10:27:39.162244Z\"\n }\n ],\n \"success\": true\n}"}],"_postman_id":"fea962e5-44d2-45d3-9bfd-91bf5b0350ed"},{"name":"Webhook detail","id":"ba19b829-912c-47be-b810-817badbfb062","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/notifications/webhook/:webhookId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","name":"Prudent AI API Documentation","type":"collection"}},"urlObject":{"path":["notifications","webhook",":webhookId"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"id":"f85176b1-9542-466a-b255-1ca77c8c4eba","type":"any","value":"","key":"webhookId"}]}},"response":[{"id":"ccce03cf-25fa-4c0a-b98f-27f15abc4eee","name":"webhook detail","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BASE_URL}}/notifications/webhook/:webhookId","host":["{{BASE_URL}}"],"path":["notifications","webhook",":webhookId"],"variable":[{"key":"webhookId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Apr 2024 10:25:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"allow","value":"GET, DELETE, HEAD, OPTIONS"},{"key":"referrer-policy","value":"same-origin"},{"key":"set-cookie","value":"sessionid=q1qxk3bkeok040c9d0xfr8icf57neykm; expires=Mon, 08 Apr 2024 10:40:14 GMT; HttpOnly; Max-Age=900; Path=/; SameSite=Lax; Secure"},{"key":"strict-transport-security","value":"max-age=900; includeSubDomains; preload"},{"key":"vary","value":"Accept, Authorization, Origin, Cookie"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"87118d60995e7f9b-MAA"},{"key":"Content-Encoding","value":"gzip"},{"key":"Cf-Team","value":"1f5ed6b06100007f9b66681400000001"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"url\": \"https://domain-name.com/ddc72472-b829-48d4-9b04-85e383bee636\",\n \"active\": true,\n \"uuid\": \"wbsecTzllWqMvkZe80iY2nqiHR49qzcGs9ZLE\",\n \"topics\": [\n \"Batch::PROCESSING_MANUALLY\",\n \"Batch::FAILED\",\n \"Batch::PROCESSED\"\n ],\n \"created\": \"2024-02-08T10:27:39.162223Z\",\n \"modified\": \"2024-02-08T10:27:39.162244Z\"\n },\n \"success\": true\n}"}],"_postman_id":"ba19b829-912c-47be-b810-817badbfb062"},{"name":"Delete webhook","id":"21fa5f59-1f0d-45a1-9691-a678c3542cf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/notifications/webhook/:webhookId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","name":"Prudent AI API Documentation","type":"collection"}},"urlObject":{"path":["notifications","webhook",":webhookId"],"host":["{{BASE_URL}}"],"query":[],"variable":[{"id":"70eaca5e-aee0-419e-9070-0b96f71b6df7","type":"any","value":"","key":"webhookId"}]}},"response":[{"id":"714f2e17-d490-445f-89d0-7407957d7982","name":"delete webhook","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/notifications/webhook/:webhookId","host":["{{BASE_URL}}"],"path":["notifications","webhook",":webhookId"],"variable":[{"key":"webhookId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Apr 2024 10:25:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"allow","value":"GET, DELETE, HEAD, OPTIONS"},{"key":"referrer-policy","value":"same-origin"},{"key":"set-cookie","value":"sessionid=q1qxk3bkeok040c9d0xfr8icf57neykm; expires=Mon, 08 Apr 2024 10:40:22 GMT; HttpOnly; Max-Age=900; Path=/; SameSite=Lax; Secure"},{"key":"strict-transport-security","value":"max-age=900; includeSubDomains; preload"},{"key":"vary","value":"Accept, Authorization, Origin, Cookie"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"87118d916fe57f9b-MAA"},{"key":"Content-Encoding","value":"gzip"},{"key":"Cf-Team","value":"1f5ed6ce5400007f9b666a0400000001"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n \"Webhook removed successfully\"\n ],\n \"success\": true\n}"}],"_postman_id":"21fa5f59-1f0d-45a1-9691-a678c3542cf3"}],"id":"afe3a721-c1de-4d52-b588-b8d026a107b8","description":"Events Supported currently are
\nBatch::PROCESSED
Batch::FAILED
Batch::PROCESSING_MANUALLY
\n\nYour Webhook endpoint ought to reply to incoming notifications with a status of 200 OK to signify its proper functioning.
\n
To ensure receipt of Webhook notifications when Firewall rules enforce a strict policy, it is necessary to whitelist the provided IPs in onboarding doc.
\nSample Webhook data:
\nBatch Processed Successfully:
\n{\n \"topic\": \"Batch::PROCESSED\",\n \"object\": {\n \"id\": 125,\n \"name\": \"Demo\",\n \"status\": \"PROCESSED\",\n \"created_at\": \"2024-02-09T15:43:52.293732Z\"\n },\n \"object_type\": \"Batch:Status::Update\",\n \"webhook_uuid\": \"ad95bdc8-f730-41c5-ae19-dee8dd9c265f\"\n}\n\nWe recommend calling results API after receiving this event with a delay of 1minute
\nAll subscribed Topics will have same attributes id, name, status, and created_at
eg.2: Batch failed
\n{\n \"topic\": \"Batch::FAILED\",\n \"object\": {\n \"id\": 121,\n \"name\": \"Demo\",\n \"status\": \"FAILED\",\n \"created_at\": \"2024-01-09T15:43:52.293732Z\"\n },\n \"object_type\": \"Batch:Status::Update\",\n \"webhook_uuid\": \"ad95bdc8-f730-41c5-ae19-dee8dd9c265f\"\n}\n\nThe following headers are send along with the POST request to ensure security and integrity
\n","_postman_id":"afe3a721-c1de-4d52-b588-b8d026a107b8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","id":"b5b93de9-4cf8-4a6b-90f8-39d369c5dc04","name":"Prudent AI API Documentation","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"c76e2703-bfaa-40a1-b817-dea8f5f09b4c"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"5981164c-66d0-4524-9dcd-fcbc2f1f6df8"}}]}