LogoLogo
NymCardAPI catalogContact usnFront catalog
  • NYMCARD DOCUMENTATION
  • Get Started
    • nCore API Quick Tutorial
    • API Core Principles
    • Program management
      • Manage documents by APIs
      • User KYB process
      • Necessary parameters per user type
      • User ID verification by SDK
      • User KYC process
    • Issuance
      • Users
      • Cards
    • Issuing Physical Cards
      • Individual card issuance
      • Bulk card issuance
      • Card fulfillment
      • Card PIN management
      • Card replacement
      • Proxy number usage
    • Issuing Virtual Cards
      • Migration of virtual to physical card
    • Funding and transfers
      • Funding
      • Internal funding source
      • External funding source
        • From card
        • From bank account
        • Lean API flow
        • DAPI direct API flow
      • Transfers
      • Western Union APIs
      • Checkout widget
    • Product Management
      • Card product
      • Balance limits
      • Velocity limits
      • Fees
      • Charges
      • Multi-currency
      • Authorization controls
        • Enhancements for MCC list management
    • Transactions
      • Payment ecosystem
      • Transaction lifecycle
      • Transaction types
      • Transaction endpoints scenarios
      • Multi-clearing process
    • Webhooks
      • Introduction to webhooks
      • nCore webhook events
      • Steps to configure a webhook
      • Webhooks samples
      • Webhook changes for simulation
      • Webhooks management
    • Security
      • PCI widget
      • 3D Secure
      • OTP SMS templates
    • Release announcements
      • Embedded Lending Release Notes
      • Changes in the release on 13/07/2023
      • Changes in the release on 23/05/2023
      • Changes in the release on 04/04/2023
  • For developers
    • nCore API catalog
    • nFront API catalog
Powered by GitBook
On this page
  • Create a user identification
  • Get a user identifications
  • Get a specific user identification
  • Update a user identification
  • Upload a user identification
  • Upload a single image of user identification
  • Return a file metadata
  • Return a file
  • Download a file
  • Delete a file

Was this helpful?

  1. Get Started
  2. Program management

Manage documents by APIs

PreviousProgram managementNextUser KYB process

Last updated 10 months ago

Was this helpful?

nCore platform’s document management feature enables you to upload and manage user identification documents (passport, visa, national ID etc.) for identity verification.

You can create and manage user’s supporting identification documents by using our following APIs available as nCore platform.

  • Create a user identification

  • Get a user identification

  • Get a specific user identification

  • Update a user identification

  • Upload a user identification

  • Upload a single image of a user identification

  • Return a file metadata

  • Return a file

  • Download a file

  • Delete a file

Create a user identification

You can create a user identification by sending a POST request to /users/{user_id}/identifications endpoint as shown below.

{ "type": "PASSPORT", "number": "132123123", "expiration_date": "2021-09-20T10:10:40.182Z", }

Get a user identifications

You can retrieve a list of user identifications by sending a GET request to /users/{user_id}/identifications endpoint as shown below.

Get a specific user identification

You can retrieve a specific user identification info by sending a GET request to /users/{user_id}/identifications/{identification_id} endpoint as shown below.

Update a user identification

You can update any user identification by sending a PUT request /users/{user_id}/identifications/{identification_id} endpoint as shown below.

Upload a user identification

You can upload more than one identification files by sending a PUT request to /users/{user_id}/identifications/{identification_id} endpoint as shown below.

Please note:

  • Using this API, you can upload maximum 5 files at a time.

  • The maximum size of the file is 128 Mb.

  • Allowed extensions are .pdf, .jpg, .jpeg, .png, .bmp, .doc, and .docx.

  • A single user identification can have maximum 10 files.

Upload a single image of user identification

You can upload a single user identification file by sending a PUT request to /users/{user_id}/identifications/{identification_id}/files endpoint as shown below.

Please note:

  • Using this API, you can upload a single file at a time.

  • The maximum size of the file is 128 Mb.

  • Allowed extensions are .pdf, .jpg, .jpeg, .png, .bmp, .doc, and .docx.

  • A single user identification can have maximum 10 files.

Note, that these APIs contain 'identification_type' and 'identification_document_type' parameters, which can have the following values:

a) identification_type = NATIONAL_ID

identification_document_type = NATIONAL_ID_FRONT & NATIONAL_ID_BACK

b) identification_type = PASSPORT

identification_document_type = PASSPORT_PAGE1 & PASSPORT_PAGE2

c) identification_type = VISA

identification_document_type = VISA

d) identification_type = TRADE_LICENSE, COMMERCIAL_LICENSE, INCORPORATION_CERT, INCUMBENCY_CERT, MEMORANDUM_ARTICLES, BANK_STATEMENT, ADDITIONAL

identification_document_type = NOT APPLICABLE

Return a file metadata

You can retrieve a specific file metadata info by sending a GET request to /users/{user_id}/identifications/{identification_id}/files/{file_id} endpoint as shown below.

Return a file

You can browse a specific user identification file by sending a GET request to /users/{user_id}/identifications/{identification_id}/files/{file_id}:browse endpoint as shown below.

Download a file

You can download a specific file by sending a GET request to /users/{user_id}/identifications/{identification_id}/files/{file_id}:download endpoint as shown below.

Delete a file

You can delete a specific user identification file by sending a DELETE request to /users/{user_id}/identifications/{identification_id}/files/{file_id} endpoint as shown below.

POST /users/{user_id}/identifications
GET /users/{user_id}/identifications
GET /users/{user_id}/identifications/{identification_id}
PUT /users/{user_id}/identifications/{identification_id}
PUT /users/{user_id}/identifications/{identification_id}/files
PUT /users/{user_id}/identifications/{identification_id}/files
GET /users/{user_id}/identifications/{identification_id}/files/{file_id}
GET /users/{user_id}/identifications/{identification_id}/files/{file_id}:browse
GET /users/{user_id}/identifications/{identification_id}/files/{file_id}:download
DELETE /users/{user_id}/identifications/{identification_id}/files/{file_id}