Getting Started Guides

Get Started: Create an Individual Customer Account

Create a new Customer Account for an Individual Customer. This account is used to store the Customer’s profile information, such as their name, address, contact information, and other personal information.

Note You can also create a Customer Account for a Business Customer.

In this guide, you’ll learn how to:

Gather the required information for the Customer.
Create a Customer Account.
Retrieve the Customer Account.

Before You Start

Sandbox Account: Sign up for a RocketKOR sandbox account. When your sandbox account is created, one or more Service Accounts will be created for your Business Account. A Service Account is a non-human user of a Business Account that performs functions (such as creating transactions) via the RocketKOR APIs on behalf of the Business Account.

Authentication: Before you can call the APIs, you must authenticate a Service Account by exchanging the account’s API key and secret for an access token.

Step 1: Gather the Required Customer Information

Ensure you have the following details for the Customer. You’ll need this information to create a Customer Account in the next step.

First name
Last name
Phone number
Email address

Step 2: Create a Customer Account

Create a Customer Account. At a minimum, the request must include the following information. You can also include additional details such as the Customer’s address, date of birth, and transaction limits for the Customer’s Financial Accounts.

Parameter	Description
type	Type of Customer. Value must be INDIVIDUAL.
firstName	Customer’s first name.
lastName	Customer’s last name.
primaryPhoneNumber.number, primaryPhoneNumber.type	Customer’s primary phone number.
primaryEmail.value	Customer’s primary email address.

API Reference

Create an Individual Customer

Endpoint

POST /v1/customers

Request Example

				
					{
  "type": "INDIVIDUAL",
  "firstName": "Sarah",
  "lastName": "Green",
  "primaryPhoneNumber": {
    "number": "+15556589",
    "type": "WORK"
  },
  "primaryEmail": {
    "value": "sgreen@abc.com"
  }
}

Response Example

Returns the Individual Customer object.

Make a note of the Customer Account id. You’ll need this ID in in the next step when you retrieve the Customer Account.

				
					{
  "id": "0e01f271-80b1-4724-b5dc-6959c7cd88dc",
  "status": "ACTIVE",
  "type": "INDIVIDUAL",
  "firstName": "Sarah",
  "lastName": "Green",
  "primaryPhoneNumber": {
    "number": "+15556589",
    "type": "WORK"
  },
  "primaryEmail": {
    "value": "sgreen@abc.com"
  },
  ...
}

Step 3: Retrieve the Customer Account

Retrieve the Customer Account you created in the previous step.

API Reference

Retrieve a Customer

Endpoint

GET /v1/customers/{customerId}

In the request, pass the Customer Account id from step 2 to the customerId parameter.

Response Example

Returns the Individual Customer object.

				
					{
  "id": "0e01f271-80b1-4724-b5dc-6959c7cd88dc",
  "status": "ACTIVE",
  "type": "INDIVIDUAL",
  "firstName": "Sarah",
  "lastName": "Green",
  "primaryPhoneNumber": {
    "number": "+15556589",
    "type": "WORK"
  },
  "primaryEmail": {
    "value": "sgreen@abc.com"
  },
  ...
}

Next Steps

Verify the Customer Account using the Identity Verification (IDV) solution.

Get Started: Create an Individual Customer Account

Before You Start

Step 1: Gather the Required Customer Information

Step 2: Create a Customer Account

API Reference

Endpoint

Request Example

Response Example

Step 3: Retrieve the Customer Account

API Reference

Endpoint

Response Example

Next Steps

ON THIS PAGE