Get single customer

GET 
/customers/:id/simple

Get a single customer with customerId -- just customer fields.

Request

Path Parameters

id uuidrequired

Responses

200

Successful response

application/json

Schema

Schema

id uuidrequired
cmsProjectId stringrequired
externalCustomerId stringnullablerequired
riskScore stringnullablerequired

Possible values: [Low, Medium, High, No risk]

type stringnullablerequired

Possible values: [Individual, Company]

onboardingLevel stringnullablerequired

Possible values: [Sign-up, AML screening, KYC, Questionaire, Onboarded, Onboarding, KYB, Onboarded]

status stringnullablerequired

Possible values: [Active, Rejected, Dormant, To be reviewed, Failed, Escalated, Terminated, No status]

createdAt date-timerequired
updatedAt date-timerequired
createdBy stringrequired
updatedBy stringrequired
reason stringnullable

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "cmsProjectId": "string",
  "externalCustomerId": "string",
  "riskScore": "Low",
  "type": "Individual",
  "onboardingLevel": "Sign-up",
  "status": "Active",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "createdBy": "string",
  "updatedBy": "string",
  "reason": "string"
}

default

Error response

application/json

Schema

Schema

message stringrequired
code stringrequired
issues object[]
Array [
message stringrequired
]

Example (from schema)

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Loading...