Productfy logoLog In

Customer

Overview

Productfy supports persons and organizations as customers. Each person or organization gets a unique ID number that is used in other API calls to perform actions on that customer like opening accounts, KYC, or initiating ACH transactions. Use these APIs to create persons and organizations and save demographic info to them (name, address, SSN, DOB, EIN, etc.). Additionally, Productfy supports storing and retrieving custom key-value pair data on persons and organizations if you would like to attach additional data to the record.

Create Person

Create a standalone person who is not associated with any login or organization. Requires tenant admin privileges. When creating a person at a minimum you must provide either the ssn or name parameter. The ssn can be provided with or without the dashes. For example, both 123-45-6789 and 123456789 are valid. Note, you must set the Primary field to true, for KYC to work correctly on your person ID.

Update Person Information

Save the person's demographic information, such as date of birth, SSN, and gender. This information is required for KYC.

Save Person Address

Save the address and associate it with a person. This information is required for KYC. The address is saved using one of the following methods:

  • Use googlePlacesId
  • Use address parameters such as streetNumber, streetName, city, and postal code

Save Person Email Address

Save a person's email address. This information is required for fraud monitoring.

Save Person Phone Number

Save a person's phone number. This information is required for fraud monitoring.

Save Custom Person Data

Save any arbitrary data you want to associate with a person, such as a photo, links to social media profiles, or additional contact information.

Get Custom Person Data

Retrieve any custom data associated with a person.

Create Organization

Save an organization's information, such as its name, description, address, EIN and other related metadata.

Retrieve Organization

Retrieve an organization's information, such as its name, description, address, ID, due diligence submission and other related metadata.

Retrieve Organization Members

Retrieve an organization's associated Person IDs.

Save Organization Address

Save an organization's address. The address is saved using one of the following methods:

  • by using googlePlacesId
  • by passing in address parameters such as streetNumber, streetName, city, and postal code

Associate Person to Organization

Associate a person with an existing organization.

Save Custom Organization Data

Save any arbitrary data you want to associate with an organization, such as a logo or additional contact information.

Get Custom Organization Data

Retrieve any custom data associated with an organization.