Get customer by ID

GET

/customers/{id}

curl --request GET \
  --url https://api.pipevest.com/v1/customers/clx0a1b2c3d4e5f6g7h8i9j0k \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-id: <x-client-id>'

• Production
• Sandbox (UAT)

Authorizations

• bearerAuth
• clientId

Parameters

Path Parameters

id

required

string

Example

clx0a1b2c3d4e5f6g7h8i9j0k

Customer identifier (CUID string).

Responses

200

Customer

Media typeapplication/json

object

data

object

id

string

organizationId

string

firstName

string

lastName

string

msisdn

string

nullable

isActive

boolean

identificationNumber

string

nullable

identificationType

string

Allowed values: SSN PASSPORT DRIVER_LICENSE NATIONAL_ID TAX_ID OTHER

referenceId

string

nullable

createdAt

string format: date-time

updatedAt

string format: date-time

Example

{
  "data": {
    "id": "clx0a1b2c3d4e5f6g7h8i9j0k",
    "organizationId": "clorgb2c3d4e5f6g7h8i9j0k1",
    "firstName": "John",
    "lastName": "Doe",
    "msisdn": "260971234567",
    "isActive": true,
    "identificationType": "SSN"
  }
}

401

Authentication failed

Media typeapplication/json

object

error

string

message

string

Example

{
  "error": "Unauthorized",
  "message": "Invalid organization authentication token"
}

404

Resource not found

Media typeapplication/json

object

error

string

message

string

Example

{
  "error": "Not found",
  "message": "Customer not found"
}