​
Overview

In the GrailPay ACH API, a Person (also referred to as a user) represents an individual entity that may be associated with a Business or Merchant. These relationships allow for flexible modeling of users within various onboarding and transaction flows. This guide covers the available endpoints for managing people, including:
  • Retrieving a list of all people
  • Retrieving a specific person
  • Deleting a person
  • Updating KYB information for a business
When you retrieve a person, their associated Business or Merchant relationships (if applicable) will also be included in the response. When deleting a person, the record is logically deleted — meaning it is no longer accessible via the API but is retained in the system for auditing and compliance purposes.

​
List People

To retrieve a list of people, you can use the endpoint that returns all people associated with your vendor. This endpoint allows you to fetch a paginated list of people, including their UUIDs, names, and email addresses. For complete request and response schemas, refer to the List Users OpenAPI Documentation.

​
Retrieve a Person

To retrieve a specific person, you will need the UUID of the person you want to retrieve. This endpoint allows you to fetch detailed information about a person, including their name, email, phone number, and the vendor they are associated with. For complete request and response schemas, refer to the Get User OpenAPI Documentation.

​
Delete a Person

To delete a specific person, you will need the UUID of the person you want to delete. This endpoint allows you to remove a person from the system, which will also make any associated information such as bank accounts, transfers, and related businesses or merchants inaccessible. For complete request and response schemas, refer to the Delete User OpenAPI Documentation.

​
Questions?

If you’re encountering any issues, contact your GrailPay integration support contact or open a support request via the portal.