GET Api/Customer/ExternalUserID?externalUserID={externalUserID}

Searches for an existing enrolled customer in the system by using the ExternalUserID provided during enrollment.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
externalUserID

string

Required

Body Parameters

None.

Response Information

Resource Description

Searches for an existing enrolled customer in the system by using the ExternalUserID provided during enrollment.

APICustomerExternalUserResponseModel
NameDescriptionTypeAdditional information
ErrorCode

Name of the error condition. See ErrorCode model for details.

ErrorCode

None.

ErrorCodeDetail

Detailed error condition code.

string

None.

ErrorID

Internal error identification number that uniquely identifies this specific error that occurred.

string

None.

ErrorNum

Numeric value of the ErrorCode

int

None.

Errors

List of errors that occurred when performing the customer operation.

Collection of string

None.

Result

On success contains the requested Customer object model. See CustomerResponseModel for details.

CustomerExternalUserResponseModel

None.

Success

Indicates sucess or failure of the REST request.

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorCode": "None",
  "ErrorCodeDetail": "sample string 1",
  "ErrorID": "sample string 2",
  "ErrorNum": 0,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Result": {
    "CustomerToken": "sample string 1"
  },
  "Success": true
}