Account Holder API

Creating an API Login

The first step in accessing the NAR API is to create an API Login, which can be done by an Account Manager through the NAR registry interface. Before you can access our production API, you need to create an API login in our test environment. Here is the link. https://nar-app-uat01.apx.com/

1. Login into NAR as an Account Manager
2. In the Account Management module on the home page, click on the link for ‘API Management’” 
   
3. On the API Management page that opens, users have the option of creating their own API Login, or delegating API access to another Account Holder that already has an API login:

1. If the user creates their own login, it will be created in ‘Inactive’ status. The registry admin will be notified and will review the login for approval. Note: Please use the format account_name+API for your login name. For example NAR is the account name, so the login name is NARAPI. No special characters can be used for the login name. Please stick to alphanumeric characters. 
2. While the login is awaiting approval, or after it is approved, the user must add the IP addresses of the machines that will be used to access the NAR APIs: 
   

These IP Addresses will also have to be approved by the registry admin. Please send an email to [e-mail] for approval of IP address. Once an user is comfortable using our API in our UAT environment we can proceed with approving an API login in Production. All account holders must start API testing in the UAT environment. Note, you will only be able to have one API login per environment. You can add multiple IPs tied to the one API login within reason. 

The next step will be for the NAR administrator to create Client_ID and Client_Secret which you will need to access the API. They will be emailed separately for confidentiality reason. 

NAR API Overview 

The NAR Registry has released a set of user-facing APIs. This initial release is focused on APIs necessary to transact certificates. These RESTful APIs include endpoints for the following: 

1. GET Certificate Holdings 
   Returns certificate holdings belonging to the specified account holder(s). 

2. GET List of counterparties 
   Returns a list of accounts from the registry. These accounts may be specified as counterparties to certificate transfers. 

3. POST Certificate Transfers 
   Initiate the transfer of certificates to another account holder. 

4. GET Pending Transfers 
   Returns a list of pending transfers (incoming and outgoing). 

5. POST Certificate Transfer Actions 
   Take action on pending transfers. Confirm or reject incoming transfers or withdraw outgoing transfers. 

6. GET Sub-Accounts 

Returns a list of sub-accounts (Active, Retirement, etc.). These sub-accounts can be specified for sub-account transfers and retirements 

7. POST Sub-Account Transfers 
   Transfer certificates within an account. 

8. POST Certificate Retirement 
   Initiate retirements for an account. 

Account Managers can create API Logins for their own accounts or delegate another account holder to act on their behalf through the API.  

Further technical documentation will be provided detailing how users will authenticate against the API (OAuth2), and the details of each endpoint. See our portal here.

https://developer.xpansiv.com/developer-portal/nar-registry/