dxp-ux

(0 reviews)

IdentityValidation

/identityValidation

[GET]

Service that allows to validate the identity of the client through a type of identity validation.

URL

https://[localhost]:[port]/dxp-ux/v1/{businessId}/identityValidation

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico	Y

name	value	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request	Y
channelId	string	Expected value APP	Y
x-account	string	account number to validate	Y

QueryParameters

name	value	description	required
identityType	string	Customer identification enum [ id, mobileNumber ,zipCode, email ]	Y
identityNumber	string	value related with the identityType	Y

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ] if idStatus=Valid

OK - request processed successfully, response body contains an entity corresponding to the requested resource.

{
  "recordId": "PRgetIdentityValidationCDC2022-10-28T12:24:18.610-04:00",
  "businessId": "PR",
  "identityNumber": "00001",
  "identityType": "id",
  "accountNumber": "8211990010043123",
  "status": true,
  "characteristic": [
    {
      "name": "zipCode",
      "valueType": "string",
      "value": "00909"
    }
  ]
}

[ 200 ] if idStatus=Invalid

{
  "recordId": "PRgetIdentityValidationCDC2022-10-28T12:22:41.957-04:00",
  "businessId": "PR",
  "identityNumber": "00001",
  "identityType": "id",
  "accountNumber": "24",
  "status": false,
  "characteristic": []
}

Definitions

Each of the request parameters is detailed.

name	type	description	required
recordId	string	transaction information	N
businessId	string	Business Id for the account	N
identityNumber	string	value related with the identityType	N
identityType	string	Customer identification enum [ id, mobileNumber ,zipCode, email ]	N
accountNumber	string		N
status	boolean	This is the user status in the system whether active or not	N
idStatus	boolean	This is the user status in the system whether active or not	N
characteristic	array	characteristics for client identity validation	N
characteristic.name	string		N
characteristic.valueType	string		N
characteristic.value	string		N