API Reference
Log In
API Reference

Managing Contacts

In This Section

The Contacts API allows you to customize the Contacts experience on your platform, including adding and managing Contacts. In the Managing Contacts section of the borderless™ you will find:

  • Definitions for Contact, Internal Contact, and External Contact.
  • How to Manage Contacts

Definitions

TermDefinition
ContactA borderless™ Contact is a payment recipient. A Contact can be a borderless™ user or a non-borderless™ user. Every Contact has a unique borderless™ @handle. To learn more about @handles please visit @Handle Overview.
Internal ContactA borderless™ Internal Contact is a Contact that is a borderless™ user and has a borderless™ Account of their own.
External ContactA borderless™ External Contact is a Contact that is NOT a borderless™ user and does NOT have a borderless™ Account of their own.

Managing Contacts

Now that you have added Contacts to your borderless™ Account, you can manage their information through the Contacts API. There are different endpoints for External and Internal Contacts. Below you can find the functionalities supported by each endpoint.

  • External Contacts: This endpoint allows you to interact with External Contacts in the following ways:

    • Retrieve the data required for creating an External Contact based upon country and account type
    • Add External Contacts
    • Check the status of an External Contact
    • Retrieve and update certain External Contact banking information and personal information
    • Retrieve payment activity
    • Resources: to learn more about the External Contacts API please visit External Contact API - Quick Start.

  • Internal Contacts: This endpoint allows you to interact with Internal Contacts in the following ways:

    • Retrieve and update certain Internal Contact personal information
    • Retrieve payment activity
    • Resources: to learn more about the Internal Contacts API please visit Internal Contacts API - Quick Start.

🚧

Authentication

Remember that all borderless™ API calls must be Authenticated. To learn more about Authentication, please visit the Authentication page.