Skip to main content
GET
/
customer-profiles
/
{customerId}
Retrieve a customer profile
curl --request GET \
  --url https://sandbox-api.finpace.example/v1/customer-profiles/{customerId} \
  --header 'Authorization: Bearer <token>'
{
  "customerId": "cus_01JQ9KN6Z9M8QEH4X8SEH8J25F",
  "partyId": "pty_01JQ9K6F0K4R9D5J5Q8C6N1J8A",
  "segment": "sme",
  "status": "active",
  "relationshipManagerId": "rm_100245",
  "riskRating": "medium",
  "customerSince": "2023-12-25",
  "preferences": {
    "language": "en",
    "channels": [
      "email"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0 with client credentials for machine integrations and authorization code for delegated user sessions.

Headers

​
X-Request-Id
string

Caller-generated correlation identifier used for tracing.

Maximum string length: 80

Path Parameters

​
customerId
string
required

Response

Customer profile returned

​
customerId
string
required
Example:

"cus_01JQ9KN6Z9M8QEH4X8SEH8J25F"

​
partyId
string
required
Example:

"pty_01JQ9K6F0K4R9D5J5Q8C6N1J8A"

​
segment
string
required
Example:

"sme"

​
status
enum<string>
required
Available options:
active,
restricted,
dormant,
closed
​
relationshipManagerId
string
Example:

"rm_100245"

​
riskRating
string
Example:

"medium"

​
customerSince
string<date>
​
preferences
object