Add a new Customer Account for an individual. The Customer Account contains the individual’s name and contact information.
Note You can also add a Customer Account for a business.
POST /v1/customers
Authorization: Bearer <access_token>
addresses
array
Customer addresses. You can add multiple addresses, such as a billing address, shipping address, and mailing address.
type REQUIRED
string enum, values: WORKPLACE, RESIDENTIAL, MAILING, BILLING, SHIPPING, OTHER
Type of address.
addressLine1 REQUIRED
string, max length: 50, min length: 1
Address line 1.
addressLine2
string, max length: 50, min length: 1
Address line 2.
addressLine3
string, max length: 50, min length: 1
Address line 3.
addressLine4
string, max length: 50, min length: 1
Address line 4.
addressLine5
string, max length: 50, min length: 1
Address line 5.
cityName
string
Customer’s city.
stateCode CONDITIONAL
string
Customer’s state, province, or territory. Required if country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2-character or 3-character country subdivision code. For example, Missouri is MO.
countryCode
string
Customer’s country. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA.
zipCode
string
Customer’s zip code or postal code.
shippingContact
object
Customer’s shipping contact person.
shipToFirstName REQUIRED
string, max length: 40, min length: 1
First name of the person responsible for receiving shipments.
shipToMiddleName
string, max length: 40, min length: 1
Middle name of the person responsible for receiving shipments.
shipToLastName REQUIRED
string, max length: 40, min length: 1
Last name of the person responsible for receiving shipments.
metadata
string, max items: 5, value max length: 1024
Use a maximum of 5 key/value pairs to store additional information about the customer.
type REQUIRED
string enum, value: INDIVIDUAL, BUSINESS
Type of customer. For individual customers, value must be INDIVIDUAL.
firstName REQUIRED
string, max length: 40, min length: 1
Customer’s first name.
middleName
string, max length: 40, min length: 1
Customer’s middle name.
lastName REQUIRED
string, max length: 40, min length: 1
Customer’s last name.
prefix
string, max length: 40, min length: 1
Title before the customer’s name (example: Dr.).
suffix
string, max length: 40, min length: 1
Title following the customer’s name (example: PhD).
sex
string enum, values: M, F
Customer’s birth sex. Possible values are M (male) and F (female).
gender
string
Customer’s gender.
securityQuestion
string
Customer’s security question.
securityAnswer
string
Customer’s security answer.
pronoun
string
Customer’s pronouns (example: He/His).
primaryPhoneNumber REQUIRED
object
Customer’s primary phone number.
number REQUIRED
string
format: [+] [country code] [phone number including area code]
Customer’s phone number. The phone number can be entered in any of the following formats:
[+] [country code] [phone number including area code] (example: +14151234)
[country code] [phone number including area code] (example: 14151234)
[phone number including area code] (example: 4151234)
RocketKOR will convert the phone number to E.164 format (example: +14151234).
type REQUIRED
string enum, values: WORK, HOME, MOBILE
Type of phone number.
provider
string, max length: 40, min length: 1
Phone provider.
extension
string, max length: 10, min length: 1
Phone extension.
verified
boolean
Whether the phone number has been verified.
primaryEmail REQUIRED
object
Customer’s primary email address.
value REQUIRED
string (email), max length: 320
Customer’s email address.
verified
boolean
Whether the email address has been verified.
dateOfBirth
string (date)
Customer’s date of birth.
Returns the customer details, including a unique ID for the account. For details, see the Individual Customer object.
SAMPLE REQUEST
{
"addresses": [
{
"type": "MAILING",
"addressLine1": "400 Richmond St",
"addressLine2": "Suite 500",
"addressLine3": "",
"addressLine4": "",
"addressLine5": "",
"cityName": "New York",
"stateCode": "NY",
"countryCode": "USA",
"zipCode": "10001"
},
{
"type": "SHIPPING",
"addressLine1": "200 Queen St",
"addressLine2": "Suite 230",
"addressLine3": "",
"addressLine4": "",
"addressLine5": "",
"cityName": "New York",
"stateCode": "NY",
"countryCode": "USA",
"zipCode": "10001"
}
],
"shippingContact": {
"shipToFirstName": "Sarah",
"shipToMiddleName": "Jane",
"shipToLastName": "Green"
},
"metadata": {
"customerRefId": "200000777"
},
"type": "INDIVIDUAL",
"firstName": "Sarah",
"middleName": "Jane",
"lastName": "Green",
"prefix": "Ms",
"suffix": "",
"sex": "F",
"gender": "",
"securityQuestion": "Who is your favorite author?",
"securityAnswer": "Barbara Gowdy",
"pronoun": "She/Her",
"primaryPhoneNumber": {
"number": "+15556589",
"type": "WORK",
"provider": "ABC",
"extension": "31",
"verified": false
},
"primaryEmail": {
"value": "sgreen@abc.com",
"verified": false
},
"dateOfBirth": "1991-06-21"
}
SAMPLE RESPONSE
{
"id": "0e01f271-80b1-4724-b5dc-6959c7cd88dc",
"status": "ACTIVE",
"addresses": [
{
"type": "MAILING",
"addressLine1": "400 Richmond St",
"addressLine2": "Suite 500",
"addressLine3": "",
"addressLine4": "",
"addressLine5": "",
"cityName": "New York",
"stateCode": "NY",
"countryCode": "USA",
"zipCode": "10001"
},
{
"type": "SHIPPING",
"addressLine1": "200 Queen St",
"addressLine2": "Suite 230",
"addressLine3": "",
"addressLine4": "",
"addressLine5": "",
"cityName": "New York",
"stateCode": "NY",
"countryCode": "USA",
"zipCode": "10001"
}
],
"shippingContact": {
"shipToFirstName": "Sarah",
"shipToMiddleName": "Jane",
"shipToLastName": "Green"
},
"metadata": {
"customerRefId": "200000777"
},
"createdBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "EMPLOYEE"
},
"createdAt": "2022-11-23T00:42:50.311Z",
"updatedBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "EMPLOYEE"
},
"updatedAt": "2022-11-23T00:42:50.311Z",
"type": "INDIVIDUAL",
"firstName": "Sarah",
"middleName": "Jane",
"lastName": "Green",
"prefix": "Ms",
"suffix": "",
"sex": "F",
"gender": "",
"securityQuestion": "Who is your favorite author?",
"securityAnswer": "Barbara Gowdy",
"pronoun": "She/Her",
"primaryPhoneNumber": {
"number": "+15556589",
"type": "WORK",
"provider": "ABC",
"extension": "31",
"verified": false
},
"primaryEmail": {
"value": "sgreen@abc.com",
"verified": false
},
"dateOfBirth": "1991-06-21"
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.