Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions code/API_definitions/customer-insights.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -223,18 +223,22 @@ components:
XCorrelator:
type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
maxLength: 256
example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
PhoneNumber:
type: string
description: A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with '+'.
pattern: '^\+[1-9][0-9]{4,14}$'
maxLength: 16
example: "+123456789"
ScoringRequest:
type: object
properties:
idDocument:
type: string
description: |-
Identification number associated to the official identity document in the country. It may contain alphanumeric characters.
maxLength: 30
phoneNumber:
$ref: "#/components/schemas/PhoneNumber"
scoringType:
Expand Down Expand Up @@ -271,21 +275,33 @@ components:
scoringValue:
type: integer
description: Result of the Scoring analysis expressed in the measure indicated in the `scoringType` field.
format: int32
oneOf:
- minimum: 0
maximum: 19
- minimum: 300
maximum: 850
ErrorInfo:
type: object
description: A structured error response providing details about a failed request, including the HTTP status code, an error code, and a human-readable message
required:
- status
- code
- message
properties:
status:
type: integer
format: int32
minimum: 100
maximum: 599
description: HTTP response status code
code:
type: string
maxLength: 96
description: A human-readable code to describe the error
message:
type: string
maxLength: 512
description: A human-readable description of what the event represents
responses:
Generic400:
Expand Down
Loading