Gatenox Hub
  • Gatenox guide
    • Introduction
    • What's new?
  • Gatenox API
    • Overview
      • Authentication
      • Rate limiting
      • Errors
    • API reference
      • Individual verifications
      • Corporate verifications
      • Case manaegment - change status
      • Attachments download
      • Verified crypto addresses
      • Comprehensive screening
      • API versions - history
    • Webhooks
  • ID Node - how to ... ?
    • What should I do after first login?
    • I received an email from Gatenox
      • Invitation for verification
      • Invitation for KYC
      • Invitation to team
    • Create and complete company profile
      • Add new company
      • Manage business information
        • Business Identity
        • Business Details
        • Business Addresses
        • Business Financials
        • Business Representatives
        • Additional information
        • Contact Details
      • Create / modify ownership structure
        • Shareholders
        • Proposed UBOs
        • UBOs
      • Verification
        • Individuals
        • Business Documents
      • Summary
        • Review and finish
    • Share company profile
      • Start onboarding
      • Complete required company data
      • Share my profile
    • I received a message from Compliance Officer
    • KYC process
      • Complete KYC details
  • Compliance Cloud - how to ... ?
    • Start onboarding customers with Gatenox
      • About your company
      • What data my company requires?
      • Referral code
      • Send the invitation for review to the corporate client
      • Send the invitation for Individual KYC
      • Apply via Gatenox
      • Integration options with Gatenox HUB
    • Multiple company profiles
    • Cases management
      • Corporate verifications
      • Individual verifications
    • Risk assessment
      • Summary
      • In-App Communication Tool
      • Ask for data update
      • Risk score recalculation
      • Company details
      • Personal details
      • Business representatives
      • UBOs
      • Company structure
      • Identified issues
      • Files
      • Additional files
      • Document AI
      • Entities verification
      • Final assessment
      • Report
    • Comprehensive screening
      • Check sanctions / PEP / criminal records
      • Check crypto addresses
      • Document AI (coming soon ...)
  • General settings
    • Account information
    • Company information
    • Billing and plans
    • Users management
    • Feedback
Powered by GitBook
On this page

Was this helpful?

  1. Gatenox API
  2. API reference

Attachments download

How to download documents using Gatenox API?

How to Download Your Document

  1. Each document in Gatenox Hub will have its own set of URLs

"documents": [
            {
                "id": "e302f38a-2bca-4d36-a6a4-1601e3bfd629",
                "purposes": [
                    "personal_document"
                ],
                "created_at": "2023-06-13T10:26:44.218Z",
                "updated_at": "2023-06-13T10:26:44.218Z",
                "document": {
                    "id": "6896ec93-7069-4467-80c1-ff9cd8e26213",
                    "country_of_issue": "PL",
                    "name": "Polish passport.png",
                    "number": "ANV 123123",
                    "document_type": "passport",
                    "date_of_issue": "2023-01-01",
                    "expiration_date": "2033-01-01",
                    "created_at": "2023-06-13T10:26:42.248Z",
                    "updated_at": "2023-06-13T10:26:42.248Z",
                    "attachments": [
                        {
                            "id": "62833342-2db1-487c-b189-4b27133dbdae",
                            "attachment_type": "main",
                            "created_at": "2023-06-13T10:26:43.193Z",
                            "updated_at": "2023-06-13T10:26:43.948Z",
                            "filename": "Polish passport.png",
                            "filesize": 22118,
                            "mime": "image/png",
                            "urls": {
                                "thumb": "https://api.sandbox.gatenox.com/verifications/47978c9b-d63f-445e-96e6-80e808e3bab1/documents/download/eyJpZCI6IjlhZDhiZmZiY.....lX3R5cGUiOiJpbWFnZS9wb",
                                "medium": "https://api.sandbox.gatenox.com/verifications/47978c9b-d63f-445e-96e6-80e808e3bab1/documents/download/eyJpZCI6ImUzZWU2NjI4NmZhM..DYxMy0yLXI4b3h3Zi5wbmc",
                                "original": "https://api.sandbox.gatenox.com/verifications/47978c9b-d63f-445e-96e6-80e808e3bab1/documents/download/eyJpZCI6IjVhMmFmNDVl...R5cGUiOiJpbWFnZS9wbmcifX0"
                            }
                        }
                    ]
                }
            }
  1. To download the document get the last set of chars after "/" (for example: eyJpZCI6IjlhZDhiZmZiY.....lX3R5cGUiOiJpbWFnZS9wb) and invoke /attachment endpoint providing the verification_id and rest parameter ("eyJpZCI6IjlhZDhiZmZiY.....lX3R5cGUiOiJpbWFnZS9wb").

Last updated 11 months ago

Was this helpful?

Download Attachement

get
Authorizations
Path parameters
reststringRequiredExample: eyJpZCI6ImI4NmQyMTE4NmU2YmZiNmM5Mjg2ZWNiOTU0N2JhYzNlLnBkZiIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjpudWxsLCJzaXplIjoxNzYzNTYsIm1pbWVfdHlwZSI6ImFwcGxpY2F0aW9uL3BkZiJ9fQ
Responses
200
Successful response
application/json
get
GET /api/v1/attachments/{rest} HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successful response

No content