Get customer statuses

POST 
/stats/app/customer-statuses

Get customer statuses.

Request

application/json

Body

required

timeframe stringrequired

Possible values: [day, week, month, year, allTime]

cmsProjectId stringrequired
customerType stringrequired

Possible values: [Individual, Company]

Responses

200

Successful response

application/json

Schema

Schema

current object[]required
Array [
state object required
anyOf
MOD1
string
Possible values: [Active, Rejected, Dormant, To be reviewed, Failed, Escalated, Terminated, No status]
MOD2
string
Possible values: [Total]
MOD3
string
Possible values: [Sign-up, AML screening, KYC, Questionaire, Onboarded]
MOD4
string
Possible values: [Onboarding, KYB, Onboarded]
count numberrequired
]
previous object[]required
Array [
state object required
anyOf
MOD1
string
Possible values: [Active, Rejected, Dormant, To be reviewed, Failed, Escalated, Terminated, No status]
MOD2
string
Possible values: [Total]
MOD3
string
Possible values: [Sign-up, AML screening, KYC, Questionaire, Onboarded]
MOD4
string
Possible values: [Onboarding, KYB, Onboarded]
count numberrequired
]

Example (from schema)

{
  "current": [
    {
      "state": "Active",
      "count": 0
    }
  ],
  "previous": [
    {
      "state": "Active",
      "count": 0
    }
  ]
}

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...