{
  "opencollection": "1.0.0",
  "info": {
    "name": "Checkout.com - Identity Verification Address document verifications (Coming soon) Address document verifications (Coming soon) ID document verifications API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "ID document verifications",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create an ID document verification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ubble.ai/v2/id-document-verifications",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates an ID document verification"
        },
        {
          "info": {
            "name": "Retrieve an ID document verification",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ubble.ai/v2/id-document-verifications/:id_document_verification_id",
            "params": [
              {
                "name": "id_document_verification_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint allows you to get the detailed results of an ID document verification"
        },
        {
          "info": {
            "name": "Anonymize an ID document verification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ubble.ai/v2/id-document-verifications/:id_document_verification_id/anonymize",
            "params": [
              {
                "name": "id_document_verification_id",
                "value": "",
                "type": "path",
                "description": "ID of the document verification to anonymize"
              }
            ]
          },
          "docs": "Anonymize the personal data of an ID document verification with the specified ID."
        },
        {
          "info": {
            "name": "List ID document verification attempts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ubble.ai/v2/id-document-verifications/:id_document_verification_id/attempts",
            "params": [
              {
                "name": "id_document_verification_id",
                "value": "",
                "type": "path",
                "description": "ID of the document verification"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of items to skip (offset)"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return per page"
              }
            ]
          },
          "docs": "This endpoint allows you to list all attempts of an ID document verification.\n\nAttempts are returned ordered by creation date, newest first.\n\nThe response is paginated (see [Pagination](#section/API-standards/Pagination) section).\nYou can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.\n"
        },
        {
          "info": {
            "name": "Create an ID document verification attempt",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ubble.ai/v2/id-document-verifications/:id_document_verification_id/attempts",
            "params": [
              {
                "name": "id_document_verification_id",
                "value": "",
                "type": "path",
                "description": "ID of the document verification"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": []
            }
          },
          "docs": "This endpoint allows you to create an ID document verification attempt. It is possible when the ID document verification is one of the following statuses: `created`, `retry_required`"
        },
        {
          "info": {
            "name": "Retrieve an ID document verification attempt",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ubble.ai/v2/id-document-verifications/:id_document_verification_id/attempts/:attempt_id",
            "params": [
              {
                "name": "id_document_verification_id",
                "value": "",
                "type": "path",
                "description": "ID of the document verification"
              },
              {
                "name": "attempt_id",
                "value": "",
                "type": "path",
                "description": "ID of the document verification attempt"
              }
            ]
          },
          "docs": "This endpoint allows you to retrieve the details for a given ID document verification attempt"
        },
        {
          "info": {
            "name": "Retrieve an ID document verification attempt asset",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ubble.ai/v2/id-document-verifications/:id_document_verification_id/attempts/:attempt_id/assets",
            "params": [
              {
                "name": "id_document_verification_id",
                "value": "",
                "type": "path",
                "description": "ID of the ID document verification"
              },
              {
                "name": "attempt_id",
                "value": "",
                "type": "path",
                "description": "ID of the ID document verification attempt"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of items to skip (offset)"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return per page"
              }
            ]
          },
          "docs": "This endpoint allows you to retrieve the assets associated with an ID document verification.\nThis includes the document front image and the document back image.\n\nThe response is paginated (see [Pagination](#section/API-standards/Pagination) section).\nYou can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.\n"
        },
        {
          "info": {
            "name": "Request webhook notification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ubble.ai/v2/id-document-verifications/:id_document_verification_id/notify",
            "params": [
              {
                "name": "id_document_verification_id",
                "value": "",
                "type": "path",
                "description": "ID of the document verification to notify"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint can be used to initiate a webhook call containing the latest event of an ID document verification"
        },
        {
          "info": {
            "name": "Retrieve PDF report of an ID document verification",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ubble.ai/v2/id-document-verifications/:id_document_verification_id/pdf-report",
            "params": [
              {
                "name": "id_document_verification_id",
                "value": "",
                "type": "path",
                "description": "ID of the ID document verification"
              }
            ]
          },
          "docs": "This endpoint allows you to retrieve a PDF report of an ID document verification.\n\nPlease note that the PDF report is only available for ID document verifications that are\nin status `declined` and `approved` once you receive the `id_document_verification_report_created` event.\n"
        }
      ]
    }
  ],
  "bundled": true
}