Skip to content

Contacts

The Contacts or Address Book endpoint offers a comprehensive solution for managing and organizing your contacts. It provides a range of operations, including creating, updating, fetching, and deleting contacts. With these endpoints, you can conveniently store and manage various contact information, including payout details such as banking information and blockchain addresses. The endpoints offer dedicated functionalities to retrieve, update, and delete this information for individual contacts in your address book.

Currently, for each contact you can store profile information, banking details for US or Canadian bank account wire/EFT transfers (refer to the Users section for information on banking details), and blockchain details such as digital wallet addresses. You have the flexibility to add, update, and retrieve profile information, banking information for fiat payouts, and digital wallet addresses for crypto transfers for each contact.

POST /contacts 
PUT /contacts
GET /contacts
DELETE /contacts
PUT /contacts/blockchainDetails
GET /contacts/blockchainDetails
DELETE /contacts/blockchainDetails
PUT /contacts/bankDetails
GET /contacts/bankDetails
DELETE /contacts/bankDetails

The endpoints are described in more detail in the following. This documentation is a summary and is meant to be read in conjunction with the swagger documentation.

POST /contacts

Create a new contact and add their payout details, blockchain addresses, and other relevant information to your address book. The sample request body below is an example of creating a contact named John Anthony Smith that is the signatory (authorized user) of the business 'Grapes Finance'. Bank details for one Canadian bank account (accepts an array if more than one) have been provided for the contact as well as one blockchain address (BlockchainDetails also accepts an array).

Sample Request Body for Contacts:

{
  "firstName": "John",
  "middleName": "Anthony",
  "lastName": "Smith",
  "email": "jasmith@grapes.com",
  "companyTitle": "Grapes Finance",
  "address": "477 Richmond Street West",
  "postalCode": "M5V 3E7",
  "countryCode": "CAN",
  "city": "Toronto",
  "stateProvince": "ON",
  "createBankDetails": [
    {
      "country": "CAN",
      "name": "Bank of Canada",
      "accHolderName": "Grapes Finance",
      "routingNum": "123-45678",
      "accountNum": "123456789",
      "achCode": "",
      "swiftBicCode": "USBKUS44MIL"
    }
  ],
  "createBlockchainDetails": [
    {
      "name": "John's wallet",
      "address": "0xd2e1dedcba9b0f9c3b049619fbf42be36c71c8bb",
      "chain": "ETHEREUM"
    }
  ]
}

PUT /contacts

Update the details of an existing contact in your address book. You can modify their name, contact information, and existing banking and blockchain details.

GET /contacts

Retrieve a list of all contacts in your address book along with their information. This allows you to view and access the complete list of contacts you have saved as well as the associated IDs (contactID, bankingDetailsId, and blockchainDetailsID)

DELETE /contacts

Remove a contact from your address book. This action permanently deletes the contact and all associated data, including payout details and blockchain addresses.

Parameters:

  • contactId (query parameter): The ID of the contact you want to delete.

PUT /contacts/blockchainDetails

Add blockchain address details for a specific contact in your address book. This allows you to add new blockchain addresses for a specific contact for third-party blockchain transfers.

GET /contacts/blockchainDetails

Retrieve the blockchain address details for a specific contact in your address book. This includes the associated blockchain addresses and relevant blockchain address information for the contact.

Parameters:

  • contactId (query parameter): The ID of the contact for which you want to fetch the blockchain address details.

DELETE /contacts/blockchainDetails

Delete the blockchain details for a specific contact in your address book. This action removes the contact's blockchain addresses and related blockchain address information from your address book.

Parameters:

  • contactId (query parameter): The ID of the contact for which you want to delete the blockchain details.
  • blockchainDetailsId (query parameter): The ID of the blockchain details you want to delete.

PUT /contacts/bankDetails

Add new banking information for a specific contact in your address book. This allows you to add new banking details for a specific contact, such as account numbers and routing information, for third-party payouts.

GET /contacts/bankDetails

Retrieve the banking information for a specific contact in your address book. This includes the contact's banking details, such as account numbers and routing information.

Parameters:

  • contactId (query parameter): The ID of the contact for which you want to fetch the banking information.

DELETE /contacts/bankDetails

Delete the banking information for a specific contact in your address book. This action removes the contact's banking details from your address book.

Parameters:

  • contactId (query parameter): The ID of the contact you'd like to delete.
  • bankingDetailsId (query parameter): The banking details ID for banking information you'd like to delete.