{"info":{"_postman_id":"ec865f81-147f-4758-b78c-786b13cae50e","name":"accessibilityCheck API","description":"

Version: v1

\n

accessibilityCheck is a suite of APIs developed by codemantra for checking document accessibility compliance against latest WCAG and PDF/UA guidelines.

\n

Once registered with codemantra for accessibilityCheck API suite, you can use below APIs for seamless integration into your products:

\n\n

For password management, you can use below APIs:

\n\n

Steps for Integration:

\n
    \n
  1. You can contact codemantra for registration.
    2. \n
  2. Once the API administrator from codemantra registers your email, you'll receive a welcome mail, along with the temporary password.
    3. \n
  3. You can set your permanent password by using the Authorize API. You'll have to send your temporary password along with your email and the password that you want to set as your permanent password.
    4. \n
  4. Once you've set your password, you can use the Authorize API to generate authorization token by passing your email and password. The generated authorization token will have to be passed in other APIs as a header.
    5. \n
  5. When you have your authorization token, you can use the Accessibility Check Request API to upload files for accessibility compliance check. The check will happen asynchronously, and you'll receive a request id to track your upload request.\n
    6. \n
  6. You can check the status of your accessibility compliance check request by using the Accessibility Check Status API, passing the request id as the path parameter.
    7. \n
  7. You can download the accessibility compliance check report as an HTML file by using the Accessibility Check Report API. The API expects the request id as the path parameter and will respond with a accessibility check report download URL, using which you can download the HTML report. The download URL will expire after 1 hour, and you can get the new URL by calling the API again. The report will be only available for download till 7 days from the time the accessibility check request was received.
    8. \n
\n

Additionally, accessibilityCheck provides websocket connect and callback url features using which you can receive real-time accessibility check notifications.

\n

If you happen to use the websocket connect feature, you'll not need to keep track of your requests by continuously polling Accessibility Check Status API.

\n

You can connect to the websocket using the below url:

\n
wss://accessibilitycheck.ws.codemantra.com?Authorization=[your-access-token]\n\n
\n

NodeJs Template for connecting to Websocket:

\n
var WebSocketClient = require(\"websocket\").client\nvar client = new WebSocketClient();\nclient.on('connectFailed', function(error) {\n    console.log('Connect Error: ' + error.toString());\n});\nclient.on('connect', function(connection) {\n    console.log('WebSocket Client Connected');\n    connection.on('error', function(error) {\n        console.log(\"Connection Error: \" + error.toString());\n    });\n    connection.on('close', function() {\n        console.log('Connection Closed');\n    });\n    connection.on('message', function(message) {\n        const content = JSON.parse(message.utf8Data);\n        if (content.event == 'accessibility-check-complete') {\n            console.log('Received new accessibility check complete notification');\n            console.log(content)\n            // Add your business logic here\n        }\n    });\n});\n// Obtain valid token from Authorize API\nconst token = \"[your-access-token]\";\nclient.connect('wss://accessibilitycheck.ws.codemantra.com?Authorization='+token);\n\n
\n

In case you wish to have your real-time accessibility check notifications pushed to an endpoint, you need to either provide the callbackUrl when you're registering for the API, or send the callbackUrl when you're giving an upload request. Once the accessibility compliance check is completed, notification will be sent on the provided callbackUrl.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14952611","collectionId":"ec865f81-147f-4758-b78c-786b13cae50e","publishedId":"UVRDGR21","public":true,"customColor":{"top-bar":"00834F","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-12-23T11:31:06.000Z"},"item":[{"name":"Authorize","id":"e8c9bf03-c5ca-4c83-b59c-67dadc42933e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\",\r\n \"password\": \"xxxxxxxx\",\r\n \"temporaryPassword\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/authorize","description":"

API for retrieving authorization token for a registered user.

\n

token provided in the response should be used as Authorization Header in other APIs.\n
\n

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
emailstringEmail of the registered user
passwordstringPassword of the registered user
\n

\n\n

Request Parameters when setting the password for the first time

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
emailstringEmail of the registered user
passwordstringPassword that will be set as the permanent password of the registered user
temporaryPasswordstringTemporary password that was sent to the registered user's mail id
\n

\n
\n\n

Response Item Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
tokenstringAuthorization Token
tokenTypestringAuthorization Token Type. Will always have value Bearer. Authorization header format to be added in other APIs is Bearer [your-access-token]
expiresInnumberDuration in seconds after which the Authorization token will expire
\n
","urlObject":{"path":["v1","authorize"],"host":["https://accessibilitycheck.api.codemantra.com"],"query":[],"variable":[]}},"response":[{"id":"cf4a9174-c69a-4567-9e14-cd8d67aaadba","name":"400 Incorrect Email or Password","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\",\r\n \"password\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/authorize"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 05:45:54 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect email or password\",\n \"item\": null\n}"},{"id":"c7f5f3e2-e5da-4f5d-86a0-9b7c5e0e60b0","name":"400 Password Does Not Coform To Policy","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\",\r\n \"password\": \"xxxxxxxx\",\r\n \"temporaryPassword\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/authorize"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"102"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 05:48:22 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Password does not conform to policy: Password must have uppercase characters\",\n \"item\": null\n}"},{"id":"7e98a024-88d0-48b6-8754-ee7032f8d1a8","name":"400 Temporary Password Missing","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\",\r\n \"password\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/authorize"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"96"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 05:43:18 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"temporaryPassword parameter is missing for setting permanent password.\",\n \"item\": null\n}"},{"id":"aeeac0e2-1b6b-47a4-a0ed-0e19d56723af","name":"400 User Doesn't Exist","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\",\r\n \"password\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/authorize"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"46"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 05:50:38 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User does not exist.\",\n \"item\": null\n}"},{"id":"aa4b8a89-06bd-4329-b1c0-b820162e4969","name":"400 Bad Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/authorize"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"35"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 05:52:17 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid request body\"\n}"},{"id":"50b86a08-6cef-4302-b1a3-095b3ec30c86","name":"200 - OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\",\r\n \"password\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/authorize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"812"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 14:19:47 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c84ecfd128e1f4c41a53a2b42410f3b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD89-C3"},{"key":"X-Amz-Cf-Id","value":"RTL5z3SE3cDPfY-hMW0Cbd5oBh0aUc0UHFsOLYwetheYAelyEk9ndg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"item\": {\n \"token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"tokenType\": \"Bearer\",\n \"expiresIn\": 3600\n }\n}"},{"id":"3727cd47-1103-4cbb-b60f-d2ca4599038d","name":"200 Password Set Using Temporary Password","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\",\r\n \"password\": \"xxxxxxxx\",\r\n \"temporaryPassword\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/authorize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"807"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 19:03:02 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"item\": {\n \"token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"tokenType\": \"Bearer\",\n \"expiresIn\": 3600\n }\n}"}],"_postman_id":"e8c9bf03-c5ca-4c83-b59c-67dadc42933e"},{"name":"Accessibility Check Request","id":"e5edf7f5-1a63-4272-a560-76cabe8503a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[your_access_token]"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"documentName\": \"sample.pdf\",\r\n \"documentUrl\": \"http://www.pdf995.com/samples/pdf.pdf\",\r\n \"format\": \"PDF\",\r\n \"info\": {\r\n \"info1\": \"sample info 1\",\r\n \"info2\": \"sample info 2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/upload","description":"

API for uploading a document for accessibility compliance check. Document uploads can be either direct (no documentUrl field in request), or via URL (documentUrl field contains file url value).

\n

In case of direct document uploads, response body will contain uploadUrl field using which document can be uploaded for accessibility compliance check.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
documentNamestringName of the Document
documentUrl
(optional)		stringUrl of the document for which accessibility compliance check is requested.
If null or missing, link will be sent in the response under uploadUrl field to upload document directly
formatstringDocument format. See Format Options section for valid formats
callbackUrl
(optional)		stringA callback URL on which the accessibility compliance check notification will be posted.
info
(optional)		objectAdditional information that needs to be associated with the document's accessibility compliance check data for downstream processing pipelines
\n

Format Options

\n

Following options are valid for format field:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
PDFPDF Format
DOCXMicrosoft Word Format
PPTXMicrosoft PPTX Format
XLSXMicrosoft XLSX Format
\n

Response Item Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
requestIdstringRequest ID, for tracking the status
uploadUrl
(optional)		stringPresigned URL to upload the document directly for accessibility compliance check, if the request doesn't contain the documentUrl parameter
info
(optional)		objectAdditional information that needs to be associated with the document's accessibility compliance check data for downstream processing pipelines
\n
","urlObject":{"path":["v1","upload"],"host":["https://accessibilitycheck.api.codemantra.com"],"query":[],"variable":[]}},"response":[{"id":"54ca98e8-ea4e-4ea7-b660-d19ea5f19383","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"documentName\": \"file-example_PDF_1MB.pdf\",\r\n \"documentUrl\": \"https://file-examples-com.github.io/uploads/2017/10/file-example_PDF_1MB.pdf\",\r\n \"format\": \"TEST\",\r\n \"info\": {\r\n \"info1\": \"sample info 1\",\r\n \"info2\": \"sample info 2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/upload"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:42:13 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"31652cc6-79e8-4138-bbe5-415e954a6c59","name":"200 OK - File Upload","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"documentName\": \"sample.pdf\",\r\n \"format\": \"PDF\",\r\n \"info\": {\r\n \"info1\": \"sample info 1\",\r\n \"info2\": \"sample info 2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/upload"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1105"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 20:58:35 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"item\": {\n \"requestId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"uploadUrl\": \"https://accessibility-check-prod-545251674201.s3.amazonaws.com/documents/2fc4abea-e60a-4517-bf98-db52c8273c19/pdf/01F2MFNKSGCTF7HWEQWWSJ5XV4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAZAGRAE6HW2V23UTQ%2F20210406%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210406T205834Z&X-Amz-Expires=3600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEN3%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIQDnznEPUZmJAK78sPJqueUDO4C%2FuXC7pEH5gC6ULNNMTAIgRkqfGkrKg3nbzYQmrTKAovQ4cjtuEwM28ws1YtdIO0Mq3AEINhACGgw2MTg5MTM2MDU1MTkiDJ9O37xWSCyj7952Zyq5AU%2F7qe86bc%2BWWLv4vwd3FJ47Y%2Fah%2FRmCI5AKMK1LYnqMQZ%2F4wO83KLd9zdPvPMDueOXzGOGC%2BaRVz%2FjUxmXVNYXsi2H1sajj2XFkjtodGuJ2PuSIj1P2xA3cT%2F5gTc2AtlRszuBkDTwkIcPDTRUHxRKx4PEYpwMzWoc%2BoOB3Hq2hu%2FdJ2wQrLsKnKSp9ZCkxycOsX%2FTikrqApu1SGWiANf%2FCk5CPKDzoCNp3AGlET%2BOtR24FPKjsNbGnMPeWs4MGOuABCq83%2BwNPx54y1P3%2BmffrOv7vRh3gn%2FazSs5ON4xoknOvyQ48E5OHCqtyVsAB5WvRJjq76kJk7ydCAZ6FgUBpMAdBH8F%2B4k2O8zV%2F3zFqS6ewEXwFhI1Wm490ApnN5HPU%2BOZ9yrau%2FsrdvqtkBar50txwNOvOGuzXiHZ%2F5nnuIIx02QQNyxTP%2F0Ok%2FJvCBennTNoGrivGgmX2v1g%2FWQ%2BWbdr75rhSuvcGMhHrY2WvvHPmihi5MrnIlTiKf%2Brp2D8dfKmKim7RTG2UpT1IuJnZi7VNwqv6sfpjOMh9T854vgs%3D&X-Amz-Signature=85cd63a8506e9c7d52425105c6baa76f02586d8f00713ae436a71b8cb2246c82&X-Amz-SignedHeaders=host%3Bx-amz-meta-documentname%3Bx-amz-meta-format%3Bx-amz-meta-requestid%3Bx-amz-meta-userid&x-amz-meta-documentname=sample.pdf&x-amz-meta-format=pdf&x-amz-meta-requestid=01F2MFNKSGCTF7HWEQWWSJ5XV4&x-amz-meta-userid=2fc4abea-e60a-4517-bf98-db52c8273c19\",\n \"info\": {\n \"info1\": \"sample info 1\",\n \"info2\": \"sample info 2\"\n }\n }\n}"},{"id":"7106f1a4-699d-4402-92e6-92a2ec16a2e4","name":"200 OK - URL Upload","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"documentName\": \"file-example_PDF_1MB.pdf\",\r\n \"documentUrl\": \"https://file-examples-com.github.io/uploads/2017/10/file-example_PDF_1MB.pdf\",\r\n \"format\": \"PDF\",\r\n \"info\": {\r\n \"info1\": \"sample info 1\",\r\n \"info2\": \"sample info 2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/upload"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"128"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:02:19 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"item\": {\n \"requestId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"info\": {\n \"info1\": \"sample info 1\",\n \"info2\": \"sample info 2\"\n }\n }\n}"},{"id":"d513f8a0-e3c2-4141-9c29-bbe2c75061a0","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"documentName\": \"file-example_PDF_1MB.pdf\",\r\n \"documentUrl\": \"https://file-examples-com.github.io/uploads/2017/10/file-example_PDF_1MB.pdf\",\r\n \"format\": \"TEST\",\r\n \"info\": {\r\n \"info1\": \"sample info 1\",\r\n \"info2\": \"sample info 2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/upload"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"35"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:04:39 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid request body\"\n}"},{"id":"d73afe63-7bb9-4a44-9704-a9a77e5effe7","name":"401 Expired Authorization Token","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"documentName\": \"file-example_PDF_1MB.pdf\",\r\n \"documentUrl\": \"https://file-examples-com.github.io/uploads/2017/10/file-example_PDF_1MB.pdf\",\r\n \"format\": \"PDF\",\r\n \"info\": {\r\n \"info1\": \"sample info 1\",\r\n \"info2\": \"sample info 2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/upload"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"44"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:49:38 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The incoming token has expired\"\n}"}],"_postman_id":"e5edf7f5-1a63-4272-a560-76cabe8503a4"},{"name":"Accessibility Check Status","id":"68bacdc9-5527-4514-baeb-08c206d4e739","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[your_access_token]"}]},"isInherited":false},"method":"GET","header":[],"url":"https://accessibilitycheck.api.codemantra.com/v1/status/:requestId","description":"

API for retrieving accessibility compliance check data of a particular uploaded document.

\n

Response Item Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
requestIdstringRequest ID, for tracking the status
requestTypestringType of upload request. One of FILE, URL
documentNamestringName of the document as provided in the upload request
formatstringFormat of the document as provided in the request. One of pdf, docx, pptx, xlsx
sizenumberSize of the document in bytes
metadataobjectMetadata of the document
validationobjectAccessibility compliance check data of the document. See Validation Object section for details
documentComplianceStatestringAccessibility compliance state of the document. One of TAGGED, UN_TAGGED, PARTIALLY_TAGGED, CORRUPTED, SECURED, NOT_FOUND, VALIDATION_FAILED
documentComplianceStatusstringAccessibility compliance status of the document. One of PASS, FAIL
alttextComplianceStatusstringAccessibility compliance status of the document w.r.t. alttext. One of PASS, FAIL, NOIMAGES
propertiesComplianceStatusstringAccessibility compliance status of the document w.r.t. properties. One of PASS, FAIL, NULL
structureComplianceStatusstringAccessibility compliance status of the document w.r.t. structure. One of PASS, FAIL, NULL
accessibilityCheckReportUrl
(optional)		stringPresigned URL to download the accessibility compliance check report in HTML format. The URL will be added in the response till 7 days from the initial upload request date
accessibilityCheckReportUrlExpiry
(optional)		stringExpiry time of the accessibility compliance report download URL in UTC
documentUrl
(optional)		stringURL of the uploaded document in case of URL based upload request
statusCodenumberStatus code of the accessibility compliance request. One of 200, 202, 206, 400, 401, 404, 500
statusstringStatus of the accessibility compliance request. One of COMPLETED, PENDING, CORRUPTED, FORMAT_ERROR, SECURED, NOT_FOUND, INTERNAL_SERVER_ERROR
info
(optional)		objectAdditional information that needs to be associated with the document's accessibility compliance data for downstream processing pipelines
callbackUrl
(optional)		stringA callback URL on which the accessibility compliance check notification will be posted.
\n

Validation Object

\n

Validation object provides complete details of the accessibility compliance check for the document. Documents are validated against accessibility compliance rules. Validation responses are grouped into three categories: altText, properties and structure.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
summaryobjectProvides count of the validation responses for the three categories altText, properties and structure as fail, warning, pass & total. The counts are aggregated across the three categories and provided under total field.
Also, an info field is provided in the summary which contains name and pages in the document
altTextListList of the altText validation responses
propertiesListList of the properties validation responses
structureListList of the structure validation responses
\n
","urlObject":{"path":["v1","status",":requestId"],"host":["https://accessibilitycheck.api.codemantra.com"],"query":[],"variable":[{"id":"4e29ffe2-4e9a-4f67-ad20-57368e2f4597","description":{"content":"

requestId of the upload request

\n","type":"text/plain"},"type":"any","value":"xxxxxxxxxxxxxxxxxxxxxxxxxx","key":"requestId"}]}},"response":[{"id":"2efae3e1-ff59-452f-b40e-3ad6312de153","name":"401 Expired Authorization Token","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"url":{"raw":"https://accessibilitycheck.api.codemantra.com/v1/status/:requestId","protocol":"https","host":["accessibilitycheck","api","codemantra","com"],"path":["v1","status",":requestId"],"variable":[{"key":"requestId","value":"xxxxxxxxxxxxxxxxxxxxxxxxxx"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"44"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:51:10 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The incoming token has expired\"\n}"},{"id":"b8dfd4cf-7fff-49bd-847a-cea5fdbd508f","name":"202 Accessibility Check Pending","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"url":{"raw":"https://accessibilitycheck.api.codemantra.com/v1/status/:requestId","protocol":"https","host":["accessibilitycheck","api","codemantra","com"],"path":["v1","status",":requestId"],"variable":[{"key":"requestId","value":"xxxxxxxxxxxxxxxxxxxxxxxxxx"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"262"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:31:35 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Accessibility check is Pending\",\n \"item\": {\n \"requestId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"requestType\": \"FILE\",\n \"documentName\": \"sample.pdf\",\n \"format\": \"pdf\",\n \"size\": 674511,\n \"statusCode\": 202,\n \"status\": \"PENDING\",\n \"info\": {\n \"info1\": \"sample info 1\",\n \"info2\": \"sample info 2\"\n }\n }\n}"},{"id":"62581e5a-75b3-41c3-8095-6a5e2f1c569a","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"url":{"raw":"https://accessibilitycheck.api.codemantra.com/v1/status/:requestId","protocol":"https","host":["accessibilitycheck","api","codemantra","com"],"path":["v1","status",":requestId"],"variable":[{"key":"requestId","value":"xxxxxxxxxxxxxxxxxxxxxxxxxx"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2792"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:24:16 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Compliance check is completed\",\n \"item\": {\n \"requestId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"requestType\": \"FILE\",\n \"documentName\": \"sample.pdf\",\n \"format\": \"pdf\",\n \"size\": 674511,\n \"metadata\": {\n \"pageCount\": \"5\",\n \"creator\": \"Acrobat PDFMaker 17 for Word\",\n \"security\": false,\n \"createdDate\": \"2020-12-16T08:11:11Z\",\n \"author\": \"Disabled Services\",\n \"modifiedDate\": \"2021-02-24T06:02:55Z\",\n \"format\": \"pdf\",\n \"producer\": \"OAT; modified using iText® 7.0.0 ©2000-2016 iText Group NV (AGPL-version)\",\n \"title\": \"TRT\"\n },\n \"validation\": {\n \"summary\": {\n \"total\": {\n \"fail\": 2,\n \"warning\": 6,\n \"total\": 38,\n \"pass\": 30\n },\n \"altText\": {\n \"fail\": 0,\n \"warning\": 0,\n \"total\": 4,\n \"pass\": 4\n },\n \"properties\": {\n \"fail\": 0,\n \"warning\": 0,\n \"total\": 8,\n \"pass\": 8\n },\n \"structure\": {\n \"fail\": 2,\n \"warning\": 6,\n \"total\": 26,\n \"pass\": 18\n },\n \"info\": {\n \"name\": \"sample.pdf\",\n \"pages\": 5\n }\n },\n \"altText\": [\n {\n \"imageDescription\": \"Fig T1\",\n \"name\": \"Graphics\",\n \"description\": \"Alt-Text present for Figure 'pg3_1.jpg' in page: 3\",\n \"validationStandard\": \"PDF-UA\",\n \"objectName\": \"pg3_1.jpg\",\n \"ruleId\": \"MH13-004 \",\n \"category\": \"Pass\",\n \"objectType\": \"Image\"\n },\n {\n \"imageDescription\": \"Fig T3\",\n \"name\": \"Graphics\",\n \"description\": \"Alt-Text present for Figure 'pg5_3.jpg' in page: 5\",\n \"validationStandard\": \"PDF-UA\",\n \"objectName\": \"pg5_3.jpg\",\n \"ruleId\": \"MH13-004 \",\n \"category\": \"Pass\",\n \"objectType\": \"Image\"\n },\n {\n \"imageDescription\": \"q Subscript z Baseline equals Start 2 By 2 Matrix line 1, 1st Column 1 2nd Column if p less than or equal to q, line 2, 1st Column left parenthesis q slash p right parenthesis Superscript z Baseline 2nd Column if p greater than q EndMatrix\",\n \"name\": \"Graphics\",\n \"description\": \"Actual Text present for Formula 'pg5_4.jpg' in page: 5\",\n \"validationStandard\": \"PDF-UA\",\n \"objectName\": \"pg5_4.jpg\",\n \"ruleId\": \"MH13-004 \",\n \"category\": \"Pass\",\n \"objectType\": \"Image\"\n },\n {\n \"imageDescription\": \"Fig T2\",\n \"name\": \"Graphics\",\n \"description\": \"Alt-Text present for Figure 'pg5_2.jpg' in page: 5\",\n \"validationStandard\": \"PDF-UA\",\n \"objectName\": \"pg5_2.jpg\",\n \"ruleId\": \"MH13-004 \",\n \"category\": \"Pass\",\n \"objectType\": \"Image\"\n }\n ],\n \"properties\": [\n {\n \"name\": \"Metadata\",\n \"description\": \"Metadata category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH6-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Dictionary\",\n \"description\": \"Dictionary category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH7-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Declared Natural Language\",\n \"description\": \"Declared Natural Language category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH11-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Page Layout\",\n \"description\": \"Page Layout is single page in PDF document.\",\n \"validationStandard\": \"PDF-UA Initial View\",\n \"ruleId\": \"ISO32000-002 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Navigation\",\n \"description\": \"Navigation tab is Bookmarks Panel and Page in PDF document.\",\n \"validationStandard\": \"PDF-UA Initial View\",\n \"ruleId\": \"ISO32000-002 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Content Tagged\",\n \"description\": \"PDF file is a Valid Tagged PDF.\",\n \"validationStandard\": \"PDF-UA 01-006\",\n \"ruleId\": \"ISO32000-002 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Magnification\",\n \"description\": \"Magnification is \\\"Fit Page\\\" in PDF document.\",\n \"validationStandard\": \"PDF-UA Initial View\",\n \"ruleId\": \"ISO32000-002 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Tab Order\",\n \"description\": \"Tab Order is in Document Structure.\",\n \"validationStandard\": \"PDF-UA Document Settings\",\n \"ruleId\": \"ISO32000-002 \",\n \"category\": \"Pass\"\n }\n ],\n \"structure\": [\n {\n \"name\": \"Annotations\",\n \"description\": \"Link tag found without annotation. In PDF page number : 1 and number of occurrences: 1\",\n \"validationStandard\": \"Best practice\",\n \"category\": \"Fail\"\n },\n {\n \"name\": \"Annotations\",\n \"description\": \"A link annotation is not nested within a Link tag. In PDF page number : 1 and number of occurrences: 1\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH28-011 \",\n \"category\": \"Fail\"\n },\n {\n \"name\": \"List\",\n \"description\": \"Element ListNumbering attribute contains \\\"Square\\\" is not matching with \\\"Lbl\\\" content \\\"•\\\". In PDF page number: 1. No. of occurrences in document: 10\",\n \"validationStandard\": \"Best practice\",\n \"category\": \"Warning\"\n },\n {\n \"name\": \"Annotations\",\n \"description\": \"Same page number found for both Source page and Destination page in PDF page number: 1 for the content: 1 and number of occurrences: 1\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH28-000 \",\n \"category\": \"Warning\"\n },\n {\n \"name\": \"Annotations\",\n \"description\": \"Same page number found for both Source page and Destination page in PDF page number: 1 for the content: 2 and number of occurrences: 1\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH28-000 \",\n \"category\": \"Warning\"\n },\n {\n \"name\": \"Annotations\",\n \"description\": \"Same page number found for both Source page and Destination page in PDF page number: 1 for the content: 3 and number of occurrences: 1\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH28-000 \",\n \"category\": \"Warning\"\n },\n {\n \"name\": \"Annotations\",\n \"description\": \"Same page number found for both Source page and Destination page in PDF page number: 1 for the content: 4 and number of occurrences: 1\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH28-000 \",\n \"category\": \"Warning\"\n },\n {\n \"name\": \"Table Header\",\n \"description\": \"Data tables should have header cells in PDF page number: 3\",\n \"validationStandard\": \"PDF-UA 15-003\",\n \"ruleId\": \"ISO32000-002 \",\n \"category\": \"Warning\"\n },\n {\n \"name\": \"Real content tagged\",\n \"description\": \"Real content tagged category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH1-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"RoleMap\",\n \"description\": \"Role Mapping category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH2-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Appropriate Tags\",\n \"description\": \"Appropriate Tags category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH9-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Character Mappings\",\n \"description\": \"Character Mappings category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH10-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Headings\",\n \"description\": \"Headings category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH14-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Table\",\n \"description\": \"Tables category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH15-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Lists\",\n \"description\": \"Lists category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH16-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Page Headers and Footers\",\n \"description\": \"Page Headers and Footers category contains no issues.\",\n \"validationStandard\": \"WCAG, PDF-UA 18\",\n \"ruleId\": \"MH18-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Notes and References\",\n \"description\": \"Notes and References category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH19-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Optional Content\",\n \"description\": \"Optional Content category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH20-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Embedded Files\",\n \"description\": \"Embedded Files category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH21-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Security\",\n \"description\": \"Security category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH26-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"XObjects\",\n \"description\": \"XObjects category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH30-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Fonts\",\n \"description\": \"Fonts category contains no issues.\",\n \"validationStandard\": \"PDF-UA\",\n \"ruleId\": \"MH31-000 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Bookmarks\",\n \"description\": \"Bookmarks found in PDF file.\",\n \"validationStandard\": \"WCAG 2.4.5\",\n \"ruleId\": \"ISO32000-002 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Password security\",\n \"description\": \"PDF is not Password Protected.\",\n \"validationStandard\": \"PDF-UA Document Settings\",\n \"ruleId\": \"ISO32000-002 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Empty Links\",\n \"description\": \"Invalid/Empty link not found in PDF.\",\n \"validationStandard\": \"PDF-UA 01-006\",\n \"ruleId\": \"ISO32000-002 \",\n \"category\": \"Pass\"\n },\n {\n \"name\": \"Bounding Box\",\n \"description\": \"Bounding Box category contains no issues.\",\n \"validationStandard\": \"PDF-UA 7.1 General\",\n \"ruleId\": \"ISO32000-002 \",\n \"category\": \"Pass\"\n }\n ]\n },\n \"documentComplianceState\": \"TAGGED\",\n \"documentComplianceStatus\": \"FAIL\",\n \"alttextComplianceStatus\": \"PASS\",\n \"propertiesComplianceStatus\": \"PASS\",\n \"structureComplianceStatus\": \"FAIL\",\n \"accessibilityCheckReportUrl\": \"https://accessibility-check-prod-545251674201.s3.amazonaws.com/reports/html/2fc4abea-e60a-4517-bf98-db52c8273c19/pdf/01F2MFNKSGCTF7HWEQWWSJ5XV4?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEN3%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJIMEYCIQDh8zPypCrS3jf2oIWqLRQqPtEMFPHS44Xn6i7hghZBQgIhAI90GHFn2I1JVNeVnj97Z2HYEaDJSzHhRLk0QotkCODwKuEBCDYQAhoMNjE4OTEzNjA1NTE5Igzik5drjOWUX%2Bjf44QqvgG%2F7M8rpi%2FKLyj7dhZvHbGjP4kNeSH06xWiiLfT6Au7cAU56waYGPBEIDlU2cfzAL9pnn%2BKYcsp4myJAfD4N5QSyqM9f58anJ75j%2F9CzFjYdsw7LW1MJ6foijQXPHnGhVjZTNT7iaxgVvJU9CwpT5nnEyDyFWofMz0gYHpXqHTwTvxPZH5h5IMwGmd0tgllDVxnknKSE7Tk6TPH3uwRCv3fUzL%2FSyHTo1sEv%2FnZxkHdHqLbXAQTtXxMOBHj5wPNMOaYs4MGOt8BeVcjnOh9mjjl3A2WHv72eUIJvgEXv79eJLL4M9kR7o%2FdPkR7fISXp8IvG1Sr6CvZ8REK58PgBI5knIxy0buJIhsKH3Ftguckg8Lc1b2AEHZ8nX6t9ghd7GhfJWsIJmXcb2NJQ%2FHxEn%2Bm5T3mjVm%2BsbtOmTsIZb5LMx6rh3C%2FeCzw0YnQsqmoHxzkBWwWIjCiHwu%2BleIGxXkJTif6ws7obfDvyw6idrtTP2DxAWcLVFtfC%2BzaWammKEB%2BnugsJnIkm1pVh8q8bXTca%2FmdSAmV7V3eAphVPfUA11cd8lLoXw%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210406T210719Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604799&X-Amz-Credential=ASIAZAGRAE6HRABN6OPT%2F20210406%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=f93ea58a5e5391da5bb5b337689c3aa2060a38a90b4f62156cf114a98c8a8387\",\n \"accessibilityCheckReportUrlExpiry\": \"2021-04-13T21:07:19Z\",\n \"statusCode\": 200,\n \"status\": \"COMPLETED\",\n \"info\": {\n \"info1\": \"sample info 1\",\n \"info2\": \"sample info 2\"\n },\n \"callbackUrl\": \"https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/dev/compliance2\"\n }\n}"},{"id":"e90706a5-0d06-4cea-9973-132c604b7f12","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://accessibilitycheck.api.codemantra.com/v1/status/:requestId","protocol":"https","host":["accessibilitycheck","api","codemantra","com"],"path":["v1","status",":requestId"],"variable":[{"key":"requestId","value":"xxxxxxxxxxxxxxxxxxxxxxxxxx"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:43:39 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"79012ebf-bd5f-4829-b849-7de571bd0348","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"url":{"raw":"https://accessibilitycheck.api.codemantra.com/v1/status/:requestId","protocol":"https","host":["accessibilitycheck","api","codemantra","com"],"path":["v1","status",":requestId"],"variable":[{"key":"requestId","value":"xxxxxxxxxxxxxxxxxxxxxxxxxx"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:36:04 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Document does not exist\",\n \"item\": null\n}"}],"_postman_id":"68bacdc9-5527-4514-baeb-08c206d4e739"},{"name":"Accessibility Check Report","id":"45eb909e-d739-40b2-b17d-7721237cfd06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[your_access_token]"}]},"isInherited":false},"method":"GET","header":[],"url":"https://accessibilitycheck.api.codemantra.com/v1/report/:requestId","description":"

API for retrieving accessibility compliance check HTML Report download url of a particular uploaded document.

\n

The report will be available for download only for 7 days from the time the accessibility check request was received.

\n
\n
\n\n

Response Item Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
requestIdstringRequest ID, for tracking the status
accessibilityCheckReportUrl
(optional)		stringPresigned URL to download the accessibility compliance check report in HTML format.
accessibilityCheckReportUrlExpiry
(optional)		stringExpiry time of the accessibility compliance check report download URL in UTC
statusCodenumberStatus code of the accessibility compliance check request. One of 200, 202, 206, 400, 401, 404, 410, 500
statusstringStatus of the accessibility compliance check request. One of COMPLETED, PENDING, CORRUPTED, FORMAT_ERROR, SECURED, NOT_FOUND, Compliance report has expired. Please send a new compliance request., INTERNAL_SERVER_ERROR
info
(optional)		objectAdditional information that needs to be associated with the document's accessibility compliance check data for downstream processing pipelines
\n
","urlObject":{"path":["v1","report",":requestId"],"host":["https://accessibilitycheck.api.codemantra.com"],"query":[],"variable":[{"id":"4fc2e28c-8a75-4f70-bc55-0818784228ed","description":{"content":"

requestId of the upload request

\n","type":"text/plain"},"type":"any","value":"xxxxxxxxxxxxxxxxxxxxxxxxxx","key":"requestId"}]}},"response":[{"id":"3b0eab69-a028-4b8f-b7b0-73b6ecaa6ed3","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"url":{"raw":"https://accessibilitycheck.api.codemantra.com/v1/report/:requestId","protocol":"https","host":["accessibilitycheck","api","codemantra","com"],"path":["v1","report",":requestId"],"variable":[{"key":"requestId","value":"xxxxxxxxxxxxxxxxxxxxxxxxxx"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:37:35 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Document does not exist\",\n \"item\": null\n}"},{"id":"452d7082-70a1-4e75-859e-0a7b9009d677","name":"202 Accessibility Check Pending","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"url":{"raw":"https://accessibilitycheck.api.codemantra.com/v1/report/:requestId","protocol":"https","host":["accessibilitycheck","api","codemantra","com"],"path":["v1","report",":requestId"],"variable":[{"key":"requestId","value":"xxxxxxxxxxxxxxxxxxxxxxxxxx"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"184"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:31:44 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Accessibility check is Pending\",\n \"item\": {\n \"requestId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"statusCode\": 202,\n \"status\": \"PENDING\",\n \"info\": {\n \"info1\": \"sample info 1\",\n \"info2\": \"sample info 2\"\n }\n }\n}"},{"id":"9e8c410c-ed74-43b9-ad3a-c0a10508aa73","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"url":{"raw":"https://accessibilitycheck.api.codemantra.com/v1/report/:requestId","protocol":"https","host":["accessibilitycheck","api","codemantra","com"],"path":["v1","report",":requestId"],"variable":[{"key":"requestId","value":"xxxxxxxxxxxxxxxxxxxxxxxxxx"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1115"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:27:56 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Accessibility report download url generated successfully\",\n \"item\": {\n \"requestId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"accessibilityCheckReportUrl\": \"https://accessibility-check-prod-545251674201.s3.amazonaws.com/reports/html/2fc4abea-e60a-4517-bf98-db52c8273c19/pdf/01F2MFNKSGCTF7HWEQWWSJ5XV4?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEN3%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJIMEYCIQDh8zPypCrS3jf2oIWqLRQqPtEMFPHS44Xn6i7hghZBQgIhAI90GHFn2I1JVNeVnj97Z2HYEaDJSzHhRLk0QotkCODwKuEBCDYQAhoMNjE4OTEzNjA1NTE5Igzik5drjOWUX%2Bjf44QqvgG%2F7M8rpi%2FKLyj7dhZvHbGjP4kNeSH06xWiiLfT6Au7cAU56waYGPBEIDlU2cfzAL9pnn%2BKYcsp4myJAfD4N5QSyqM9f58anJ75j%2F9CzFjYdsw7LW1MJ6foijQXPHnGhVjZTNT7iaxgVvJU9CwpT5nnEyDyFWofMz0gYHpXqHTwTvxPZH5h5IMwGmd0tgllDVxnknKSE7Tk6TPH3uwRCv3fUzL%2FSyHTo1sEv%2FnZxkHdHqLbXAQTtXxMOBHj5wPNMOaYs4MGOt8BeVcjnOh9mjjl3A2WHv72eUIJvgEXv79eJLL4M9kR7o%2FdPkR7fISXp8IvG1Sr6CvZ8REK58PgBI5knIxy0buJIhsKH3Ftguckg8Lc1b2AEHZ8nX6t9ghd7GhfJWsIJmXcb2NJQ%2FHxEn%2Bm5T3mjVm%2BsbtOmTsIZb5LMx6rh3C%2FeCzw0YnQsqmoHxzkBWwWIjCiHwu%2BleIGxXkJTif6ws7obfDvyw6idrtTP2DxAWcLVFtfC%2BzaWammKEB%2BnugsJnIkm1pVh8q8bXTca%2FmdSAmV7V3eAphVPfUA11cd8lLoXw%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210406T210719Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604799&X-Amz-Credential=ASIAZAGRAE6HRABN6OPT%2F20210406%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=f93ea58a5e5391da5bb5b337689c3aa2060a38a90b4f62156cf114a98c8a8387\",\n \"accessibilityCheckReportUrlExpiry\": \"2021-04-13T21:07:19Z\",\n \"statusCode\": 200,\n \"status\": \"COMPLETED\",\n \"info\": {\n \"info1\": \"sample info 1\",\n \"info2\": \"sample info 2\"\n }\n }\n}"},{"id":"e3bdbe41-5cbe-4dcc-b19b-37bfb89a9f58","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"https://accessibilitycheck.api.codemantra.com/v1/report/:requestId","protocol":"https","host":["accessibilitycheck","api","codemantra","com"],"path":["v1","report",":requestId"],"variable":[{"key":"requestId","value":"xxxxxxxxxxxxxxxxxxxxxxxxxx"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:44:57 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"059cee2d-9537-4aa8-970a-f6a0aae98a03","name":"401 Expired Authrization Token","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"url":{"raw":"https://accessibilitycheck.api.codemantra.com/v1/report/:requestId","protocol":"https","host":["accessibilitycheck","api","codemantra","com"],"path":["v1","report",":requestId"],"variable":[{"key":"requestId","value":"xxxxxxxxxxxxxxxxxxxxxxxxxx"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"44"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:53:18 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The incoming token has expired\"\n}"}],"_postman_id":"45eb909e-d739-40b2-b17d-7721237cfd06"},{"name":"Change Password","id":"10c9e381-bb3f-4512-b480-a7e9a16a80ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[your_access_token]"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"previousPassword\": \"xxxxxxxx\",\r\n \"proposedPassword\": \"xxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/change","description":"

API to change a user's password.

\n
\n
\n\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
previousPasswordstringCurrent password of the registered user
proposedPasswordstringNew password of the registered user
\n
","urlObject":{"path":["v1","user","password","change"],"host":["https://accessibilitycheck.api.codemantra.com"],"query":[],"variable":[]}},"response":[{"id":"6198b9c7-7f1d-432c-96ae-de3bc81a3b5f","name":"400 Password Did Not Conform To Policy","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"previousPassword\": \"xxxxxxxx\",\r\n \"proposedPassword\": \"xxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/change"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 22:06:05 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Password did not conform with policy: Password not long enough\"\n}"},{"id":"75a615a9-3631-439a-b8fb-57c9f6924073","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"previousPassword\": \"xxxxxxxx\",\r\n \"proposedPassword\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/change"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 21:58:43 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"},{"id":"07370475-1376-468b-a7d7-6c8e1a16a079","name":"400 Bad Request","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"previousPassword\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/change"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"35"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 22:00:45 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid request body\"\n}"},{"id":"ea7c1d6a-24bf-4ae1-a211-de23fbdc20a0","name":"401 Expired Authorization Token","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"previousPassword\": \"xxxxxxxx\",\r\n \"proposedPassword\": \"xxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/change"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"44"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 22:11:59 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The incoming token has expired\"\n}"},{"id":"732fef3a-69ed-4a85-a5be-8fb144dc1aac","name":"400 Incorrect Previous Password","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer [your_access_token]","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"previousPassword\": \"xxxxxxxx\",\r\n \"proposedPassword\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/change"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"41"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 22:02:38 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect previous password\"\n}"},{"id":"bac168b1-dd97-455b-b78c-03113b0707e3","name":"401 Unauthorized","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"previousPassword\": \"xxxxxxxx\",\r\n \"proposedPassword\": \"xxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/change"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 06 Apr 2021 22:10:19 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amzn-ErrorType","value":"UnauthorizedException"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"}],"_postman_id":"10c9e381-bb3f-4512-b480-a7e9a16a80ff"},{"name":"Forgot Password","id":"16c2dd76-462d-42f2-a373-3b253c42d1a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/forgot","description":"

API to request password reset, in case the user has forgotten his current password.

\n

Once the request is received, a mail will be sent to the user's registered email with the verification code for the password reset. The verification code can then be used in the Reset Password API to reset the user password.

\n
\n
\n\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
emailstringEmail of the registered user
\n
","urlObject":{"path":["v1","user","password","forgot"],"host":["https://accessibilitycheck.api.codemantra.com"],"query":[],"variable":[]}},"response":[{"id":"1802b1b4-cd64-4b81-bc53-4492ce8c6b6f","name":"400 Disabled User","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/forgot"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"31"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 03:51:43 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User is disabled.\"\n}"},{"id":"1041b26a-bf83-4e8d-a6e4-1352b3db044d","name":"400 Bad Request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/forgot"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"35"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 03:49:57 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid request body\"\n}"},{"id":"d45f09ae-67ff-4f63-a3b5-8614828fc456","name":"400 User Doesn't Exist","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/forgot"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 03:47:27 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User does not exist.\"\n}"},{"id":"5fcee991-4ca6-408d-a952-9ea471073f25","name":"200 OK","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/forgot"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 03:37:12 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"}],"_postman_id":"16c2dd76-462d-42f2-a373-3b253c42d1a8"},{"name":"Reset Password","id":"cae6e5bb-8d20-4b76-9eb5-c104bdd3f350","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\",\r\n \"confirmationCode\": \"xxxxxx\",\r\n \"password\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/reset","description":"

API to reset a user's password.

\n

If a user has requested password reset, a verification code will be sent to the registered email. The user can then use this API to reset his password by passing the confirmation code along with the new password.

\n
\n
\n\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
emailstringEmail of the registered user
passwordstringNew password of the registered user
confirmationCodestringVerification code that was sent to the registered user's mail for resetting the password
\n
","urlObject":{"path":["v1","user","password","reset"],"host":["https://accessibilitycheck.api.codemantra.com"],"query":[],"variable":[]}},"response":[{"id":"d129a882-efcf-4662-89b7-4e52c9849d82","name":"400 Invalid Confirmation Code","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\",\r\n \"confirmationCode\": \"xxxxxx\",\r\n \"password\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/reset"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 04:01:20 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid code provided, please request a code again.\"\n}"},{"id":"0454e913-0273-427b-94e8-78839ddb6823","name":"400 Password Did Not Conform To Policy","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\",\r\n \"confirmationCode\": \"xxxxxx\",\r\n \"password\": \"xxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/reset"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"75"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 04:08:31 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Password does not conform to policy: Password not long enough\"\n}"},{"id":"e47fadda-0e36-4716-88f6-9860aa3b12ff","name":"400 User Doesn't Exist","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\",\r\n \"confirmationCode\": \"xxxxxx\",\r\n \"password\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/reset"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 03:59:18 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User does not exist.\"\n}"},{"id":"24212c6f-dfa1-41bb-a699-29379a205e87","name":"200 OK","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\",\r\n \"confirmationCode\": \"xxxxxx\",\r\n \"password\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/reset"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 03:55:39 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\"\n}"},{"id":"11ce30ea-d299-4d64-949d-3c7381472423","name":"400 Bad Request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user@codemantra.com\",\r\n \"password\": \"xxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://accessibilitycheck.api.codemantra.com/v1/user/password/reset"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"35"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 07 Apr 2021 04:11:25 GMT"},{"key":"x-amzn-RequestId","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"x-amz-apigw-id","value":"xxxxxxxxxxxxxxxx"},{"key":"X-Amzn-Trace-Id","value":"Root=1-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"X-Amz-Cf-Pop","value":"xxxxxxxx"},{"key":"X-Amz-Cf-Id","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid request body\"\n}"}],"_postman_id":"cae6e5bb-8d20-4b76-9eb5-c104bdd3f350"}],"event":[{"listen":"prerequest","script":{"id":"a3283026-554a-4f5e-9df6-191c6b640ac9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6efa7a71-4505-4705-a878-eb9e13fa78c6","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://accessibilitycheck.api.codemantra.com"},{"key":"version","value":"v1"},{"key":"token","value":"[your_access_token]"}]}