POST v1/Partner/GetCustomerIdentification

No documentation available.

Request Information

Parameters (ParameterName * = required)

Name
Description
Sample Value
FirstName
The first name of the customer.
Tyler
MiddleName
The middle name of the customer.
Jack
LastName
The last name of the customer.
Durden
LastName2
The 2nd last name of the recipient.
Singer
Country *
The 2-letter country code of the recipient's address
MX
EmailAddress *
The email address of the customer.
yourname@example.com
Occupation
The customer's day job.
Surfer
IdDocumentNumber
The identification value for the customer (drivers license number, passport number, etc.).
2559-2150-094F
IdDocumentExpiration
The identification expiration.
1985-09-25
IssuedByState
The identification issuing state
Baja California
IdDocumentType
Identification document type (DriverLicense or StateIdentification).
Not available
Address
Address of the customer.
1503 Ria St.
UnitNumber
Unit or apartment number for the address.
Apt. 10
PostalCode
Zip / Postal code of the customer's address
80201
City *
The city of the customer's address.
Tijuana
State *
The state of the customer's address.
Baja California
DateOfBirth
Date of birth for the customer.
1985-09-25
HomePhone
No description available
Not available
MobilePhone
No description available
Not available
SendToCountry
No description available
Not available
PhoneNumberCountryIso
No description available
Not available
TelephoneNumber
The home phone number for the customer.
555-555-5555
TelephoneNumberCell
The cell phone number for the customer.
555-555-5555
MfaPreference
No description available
Not available
IsReferred
No description available
Not available

Response Information

Response body formats

application/json, text/json

Sample: 
{
  "id": 1,
  "documentTypeId": 1,
  "documentTypeName": "sample string 1",
  "specificTypeId": 1,
  "specificIdTypeName": "sample string 2",
  "displayName": "sample string 3",
  "identificationNumber": "sample string 4",
  "expirationDate": "2025-05-04T20:08:57.585358-07:00",
  "issuedDate": "2025-05-04T20:08:57.585358-07:00",
  "issuedBy": "sample string 5",
  "isVerified": true,
  "isDefault": true,
  "issuedByCountry": "sample string 7",
  "issuedByState": "sample string 8",
  "issuedByStateId": 1,
  "imageId": 1,
  "createDateTime": "2025-05-04T20:08:57.585358-07:00",
  "isExpired": true
}

application/xml, text/xml

Sample: 
<IdDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DataModels">
  <_x003C_CreateDateTime_x003E_k__BackingField>2025-05-04T20:08:57.585358-07:00</_x003C_CreateDateTime_x003E_k__BackingField>
  <_x003C_DisplayName_x003E_k__BackingField>sample string 3</_x003C_DisplayName_x003E_k__BackingField>
  <_x003C_DocumentTypeId_x003E_k__BackingField>1</_x003C_DocumentTypeId_x003E_k__BackingField>
  <_x003C_DocumentTypeName_x003E_k__BackingField>sample string 1</_x003C_DocumentTypeName_x003E_k__BackingField>
  <_x003C_ExpirationDate_x003E_k__BackingField>2025-05-04T20:08:57.585358-07:00</_x003C_ExpirationDate_x003E_k__BackingField>
  <_x003C_Id_x003E_k__BackingField>1</_x003C_Id_x003E_k__BackingField>
  <_x003C_IdentificationNumber_x003E_k__BackingField>sample string 4</_x003C_IdentificationNumber_x003E_k__BackingField>
  <_x003C_ImageId_x003E_k__BackingField>1</_x003C_ImageId_x003E_k__BackingField>
  <_x003C_IsDefault_x003E_k__BackingField>true</_x003C_IsDefault_x003E_k__BackingField>
  <_x003C_IsExpired_x003E_k__BackingField>true</_x003C_IsExpired_x003E_k__BackingField>
  <_x003C_IsVerified_x003E_k__BackingField>true</_x003C_IsVerified_x003E_k__BackingField>
  <_x003C_IssuedByCountry_x003E_k__BackingField>sample string 7</_x003C_IssuedByCountry_x003E_k__BackingField>
  <_x003C_IssuedByStateId_x003E_k__BackingField>1</_x003C_IssuedByStateId_x003E_k__BackingField>
  <_x003C_IssuedByState_x003E_k__BackingField>sample string 8</_x003C_IssuedByState_x003E_k__BackingField>
  <_x003C_IssuedBy_x003E_k__BackingField>sample string 5</_x003C_IssuedBy_x003E_k__BackingField>
  <_x003C_IssuedDate_x003E_k__BackingField>2025-05-04T20:08:57.585358-07:00</_x003C_IssuedDate_x003E_k__BackingField>
  <_x003C_SpecificIdTypeName_x003E_k__BackingField>sample string 2</_x003C_SpecificIdTypeName_x003E_k__BackingField>
  <_x003C_SpecificTypeId_x003E_k__BackingField>1</_x003C_SpecificTypeId_x003E_k__BackingField>
</IdDocument>