Retrieves Scoring information

POST/customerinsights/scoring/retrieve

Retrieves Scoring information, for the user associated with the provided idDocument, phoneNumber or the combination of both parameters. It also allows to select the type of the Scoring scale measurement.

Header ParametersExpand Collapse

"x-correlator": optional string

Body ParametersJSONExpand Collapse

idDocument: optional string

Identification number associated to the official identity document in the country. It may contain alphanumeric characters.

phoneNumber: optional string

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

scoringType: optional "gaugeMetric" or "veritasIndex"

Scoring type, i.e.: scale. API Client may use this field to indicate the Scoring in one of the defined scales; if this field is not informed, the API will return the Scoring in the scale configured by default in the system.

Allowed values are:

gaugeMetric: ranges from index 850 (lowest risk) to index 300 (highest risk)
veritasIndex: ranges from index 0 (lowest risk) to index 19 (highest risk)

One of the following:

"gaugeMetric"

"veritasIndex"

ReturnsExpand Collapse

scoringType: "gaugeMetric" or "veritasIndex"

Scoring measurement system.

Allowed values are:

gaugeMetric: ranges from index 850 (lowest risk) to index 300 (highest risk)
veritasIndex: ranges from index 0 (lowest risk) to index 19 (highest risk)

One of the following:

"gaugeMetric"

"veritasIndex"

scoringValue: number

Result of the Scoring analysis expressed in the measure indicated in the scoringType field.

Retrieves Scoring information

curl https://api.example.com/camara/customerinsights/scoring/retrieve \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CAMARA_BEARER_TOKEN" \
    -d '{}'

{
  "scoringType": "gaugeMetric",
  "scoringValue": 600
}

{
  "scoringType": "veritasIndex",
  "scoringValue": 4
}

{
  "status": 400,
  "code": "INVALID_ARGUMENT",
  "message": "Client specified an invalid argument, request body or query param"
}

{
  "status": 401,
  "code": "UNAUTHENTICATED",
  "message": "Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required."
}

{
  "status": 403,
  "code": "PERMISSION_DENIED",
  "message": "Client does not have sufficient permissions to perform this action."
}

{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "The specified resource is not found."
}

{
  "status": 404,
  "code": "IDENTIFIER_NOT_FOUND",
  "message": "phoneNumber not found."
}

{
  "status": 422,
  "code": "SERVICE_NOT_APPLICABLE",
  "message": "The service is not available for the provided identifier."
}

{
  "status": 422,
  "code": "MISSING_IDENTIFIER",
  "message": "The phone number cannot be identified."
}

{
  "status": 422,
  "code": "UNNECESSARY_IDENTIFIER",
  "message": "The phone number is already identified by the access token."
}

{
  "status": 422,
  "code": "CUSTOMER_INSIGHTS.SCALE_TYPE_NOT_SUPPORTED",
  "message": "Indicated parameter `scoringType` is not supported."
}

{
  "status": 422,
  "code": "CUSTOMER_INSIGHTS.INVALID_IDENTIFIERS",
  "message": "The request contains invalid data."
}

{
  "status": 422,
  "code": "CUSTOMER_INSIGHTS.ID_DOCUMENT_NOT_SUPPORTED",
  "message": "Indicated parameter `idDocument` is not supported"
}

{
  "status": 422,
  "code": "CUSTOMER_INSIGHTS.ID_DOCUMENT_REQUIRED",
  "message": "The `idDocument` is required to perform the properties validation."
}

{
  "status": 429,
  "code": "TOO_MANY_REQUESTS",
  "message": "Rate limit reached."
}

Returns Examples

{
  "scoringType": "gaugeMetric",
  "scoringValue": 600
}

{
  "scoringType": "veritasIndex",
  "scoringValue": 4
}

{
  "status": 400,
  "code": "INVALID_ARGUMENT",
  "message": "Client specified an invalid argument, request body or query param"
}

{
  "status": 401,
  "code": "UNAUTHENTICATED",
  "message": "Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required."
}

{
  "status": 403,
  "code": "PERMISSION_DENIED",
  "message": "Client does not have sufficient permissions to perform this action."
}

{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "The specified resource is not found."
}

{
  "status": 404,
  "code": "IDENTIFIER_NOT_FOUND",
  "message": "phoneNumber not found."
}

{
  "status": 422,
  "code": "SERVICE_NOT_APPLICABLE",
  "message": "The service is not available for the provided identifier."
}

{
  "status": 422,
  "code": "MISSING_IDENTIFIER",
  "message": "The phone number cannot be identified."
}

{
  "status": 422,
  "code": "UNNECESSARY_IDENTIFIER",
  "message": "The phone number is already identified by the access token."
}

{
  "status": 422,
  "code": "CUSTOMER_INSIGHTS.SCALE_TYPE_NOT_SUPPORTED",
  "message": "Indicated parameter `scoringType` is not supported."
}

{
  "status": 422,
  "code": "CUSTOMER_INSIGHTS.INVALID_IDENTIFIERS",
  "message": "The request contains invalid data."
}

{
  "status": 422,
  "code": "CUSTOMER_INSIGHTS.ID_DOCUMENT_NOT_SUPPORTED",
  "message": "Indicated parameter `idDocument` is not supported"
}

{
  "status": 422,
  "code": "CUSTOMER_INSIGHTS.ID_DOCUMENT_REQUIRED",
  "message": "The `idDocument` is required to perform the properties validation."
}

{
  "status": 429,
  "code": "TOO_MANY_REQUESTS",
  "message": "Rate limit reached."
}