Retrieve a Customer

Retrieve a Customer Account. This retrieve’s the Customer’s profile information.

Endpoint

GET /v1/customers/{customerId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

customerId

string (UUID)

ID of the Customer Account.

Request Body

None

Returns

Returns the Business Customer or Individual Customer object. These objects contain the Customer Account details.

SAMPLE RESPONSE

				
					{
  "id": "e4021849-0e09-43ef-b9a7-18124356f489",
  "status": "ACTIVE",
  "addresses": [
    {
      "type": "MAILING",
      "streetLine1": "100 Main St",
      "streetLine2": "Suite 100",
      "streetLine3": "",
      "streetLine4": "",
      "streetLine5": "",
      "cityName": "Greenville",
      "stateCode": "MO",
      "countryCode": "USA",
      "zipCode": "63368",
      "primary": true
    },
    {
      "type": "SHIPPING",
      "name": {
        "firstName": "Jack",
        "middleName": "Fred",
        "lastName": "Smith"
      },
      "streetLine1": "200 King St",
      "streetLine2": "Suite 310",
      "streetLine3": "",
      "streetLine4": "",
      "streetLine5": "",
      "cityName": "Greenville",
      "stateCode": "MO",
      "countryCode": "USA",
      "zipCode": "63368",
      "primary": true
    }
  ],
  "metadata": {
    "customerRefId": "100000333"
  },
  "createdBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "service-account"
  },
  "createdAt": "2022-11-23T00:42:50.311Z",
  "updatedBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "service-account"
  },
  "updatedAt": "2022-12-11T00:42:50.311Z",
  "type": "BUSINESS",
  "doingBusinessAsName": "ACME Corp.",
  "contacts": [
    {
      "firstName": "Jack",
      "middleName": "Fred",
      "lastName": "Smith",
      "primary": true,
      "primaryPhoneNumber": {
        "number": "+14151234",
        "type": "WORK",
        "provider": "ABC",
        "extension": "675",
        "verified": false
      },
      "primaryEmail": {
        "value": "jsmith@acme.com",
        "verified": false
      }
    }
  ],
  "legalName": "ACME Corporation",
  "primaryPhone": "+14151234",
  "website": "https://www.acme.com",
  "dateOfFormation": "2010-01-31",
  "legalEntityType": "CORP",
  "taxIdCountryCode": "USA",
  "taxId": "12-3456789"
}