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
    • 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
  • What is a user
  • Create a user
  • Retrieve users
  • Update a user

Was this helpful?

  1. Get Started
  2. Issuance

Users

PreviousIssuanceNextCards

Last updated 10 months ago

Was this helpful?

What is a user

A user is an entity which can be an individual that holds an account at nCore which is represented by the user object. The user object stores the user's demographic data like (name, date of birth, email, address, nationality, gender etc.). Your application calls the nCore API to create and manage the users and their identification.

nCore supports linking multiple users in a parent-child relationship. You can use the /users endpoint to create these relationships between two users (where one user is the parent and the other is the child). The parent-child relationship can be extended to n-level of parent-child hierarchy. This relationship is very useful in maintaining real world relationships between multiple users.

To create a parent-child relationship, the parent must be an existing user. When creating a child user, set the parent_user_id field to the unique identifier of the parent. The parent_user_id can also be set or reset later on by using the update user API.

Below you can find user management decision flow:

Create a user

Before creating user, what you will need:

  • A nCore API Key

  • Details about the individual you would like to onboard

Create an individual user

The following is sample code used to create a normal user.

Create a child user

If you want to create a child user please include the parent user id in your POST request as given below.

Retrieve users

nCore supports following retrieval methods.

  • To retrieve a list of all users, you can send a GET request to /users endpoint

  • To retrieve a specific user, you can include the user ‘ID’ path parameter in your GET request

  • To retrieve a specific user by name, email id or phone number as given below.

  • You can retrieve child users for a specific parent user as given below.

Update a user

You can update a specific user by sending a PUT request to /users/{id} endpoint as given below.

{

"first_name": "John", "last_name": "Smith"

}

{

"first_name": "John", "last_name": "Smith", “parent_user_id”: “cf2de83b-ac68-44ab-bc54-21de60014d57”

}

{

"name": "John", "mobile": "5503523", "email": "johndoe@", "limit": "10", "after": "MTA="

}

POST /users
POST /users
GET /users
GET /users/{id}
POST /users:search
GET /users/{id}:getLinkedRelationships
PUT /users/{id}