PUT v1/IdentityVerification/GetDocumentTypeDetails
Get details about id document types for the given conditions If you don't know the generic type yet, use GetAvailableDocumentTypes()
Request Information
Parameters (ParameterName * = required)
Name
Description
Sample Value
DocumentTypeId
Generic Document Type Id
Not available
SpecificTypeId
Specific Document Type Id
Not available
IssuedStateId
The StateId
Not available
AgentCountryCode *
Country Code for agent/site
Not available
IssuedCountryCode *
The Country Abbreviation
Not available
Response Information
Response body formats
application/json, text/json
Sample:
{
"detailLevel": "Country",
"genericDocumentTypes": [
{
"id": "sample string 1",
"name": "sample string 2"
},
{
"id": "sample string 1",
"name": "sample string 2"
},
{
"id": "sample string 1",
"name": "sample string 2"
}
],
"specificDocumentTypes": [
{
"id": "sample string 1",
"name": "sample string 2",
"organizationRequired": true,
"issuedStateRequired": true,
"issuedDateRequired": true,
"expirationDateRequired": true,
"genericRegexValidator": "sample string 7"
},
{
"id": "sample string 1",
"name": "sample string 2",
"organizationRequired": true,
"issuedStateRequired": true,
"issuedDateRequired": true,
"expirationDateRequired": true,
"genericRegexValidator": "sample string 7"
},
{
"id": "sample string 1",
"name": "sample string 2",
"organizationRequired": true,
"issuedStateRequired": true,
"issuedDateRequired": true,
"expirationDateRequired": true,
"genericRegexValidator": "sample string 7"
}
],
"availableCountries": [
{
"id": 1,
"name": "sample string 2",
"abbreviation": "sample string 3"
},
{
"id": 1,
"name": "sample string 2",
"abbreviation": "sample string 3"
},
{
"id": 1,
"name": "sample string 2",
"abbreviation": "sample string 3"
}
],
"availableStates": [
{
"id": 1,
"name": "sample string 2",
"abbreviation": "sample string 3"
},
{
"id": 1,
"name": "sample string 2",
"abbreviation": "sample string 3"
},
{
"id": 1,
"name": "sample string 2",
"abbreviation": "sample string 3"
}
]
}
application/xml, text/xml
Sample:
<IdDocumentTypeSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DataModels">
<_x003C_AvailableCountries_x003E_k__BackingField>
<IdDocumentTypeLocationDetails>
<_x003C_Abbreviation_x003E_k__BackingField>sample string 3</_x003C_Abbreviation_x003E_k__BackingField>
<_x003C_Id_x003E_k__BackingField>1</_x003C_Id_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
</IdDocumentTypeLocationDetails>
<IdDocumentTypeLocationDetails>
<_x003C_Abbreviation_x003E_k__BackingField>sample string 3</_x003C_Abbreviation_x003E_k__BackingField>
<_x003C_Id_x003E_k__BackingField>1</_x003C_Id_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
</IdDocumentTypeLocationDetails>
<IdDocumentTypeLocationDetails>
<_x003C_Abbreviation_x003E_k__BackingField>sample string 3</_x003C_Abbreviation_x003E_k__BackingField>
<_x003C_Id_x003E_k__BackingField>1</_x003C_Id_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
</IdDocumentTypeLocationDetails>
</_x003C_AvailableCountries_x003E_k__BackingField>
<_x003C_AvailableStates_x003E_k__BackingField>
<IdDocumentTypeLocationDetails>
<_x003C_Abbreviation_x003E_k__BackingField>sample string 3</_x003C_Abbreviation_x003E_k__BackingField>
<_x003C_Id_x003E_k__BackingField>1</_x003C_Id_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
</IdDocumentTypeLocationDetails>
<IdDocumentTypeLocationDetails>
<_x003C_Abbreviation_x003E_k__BackingField>sample string 3</_x003C_Abbreviation_x003E_k__BackingField>
<_x003C_Id_x003E_k__BackingField>1</_x003C_Id_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
</IdDocumentTypeLocationDetails>
<IdDocumentTypeLocationDetails>
<_x003C_Abbreviation_x003E_k__BackingField>sample string 3</_x003C_Abbreviation_x003E_k__BackingField>
<_x003C_Id_x003E_k__BackingField>1</_x003C_Id_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
</IdDocumentTypeLocationDetails>
</_x003C_AvailableStates_x003E_k__BackingField>
<_x003C_DetailLevel_x003E_k__BackingField>Country</_x003C_DetailLevel_x003E_k__BackingField>
<_x003C_GenericDocumentTypes_x003E_k__BackingField>
<IdDocumentGenericType>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
</IdDocumentGenericType>
<IdDocumentGenericType>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
</IdDocumentGenericType>
<IdDocumentGenericType>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
</IdDocumentGenericType>
</_x003C_GenericDocumentTypes_x003E_k__BackingField>
<_x003C_SpecificDocumentTypes_x003E_k__BackingField>
<IdDocumentSpecificType>
<_x003C_ExpirationDateRequired_x003E_k__BackingField>true</_x003C_ExpirationDateRequired_x003E_k__BackingField>
<_x003C_GenericRegexValidator_x003E_k__BackingField>sample string 7</_x003C_GenericRegexValidator_x003E_k__BackingField>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_IssuedDateRequired_x003E_k__BackingField>true</_x003C_IssuedDateRequired_x003E_k__BackingField>
<_x003C_IssuedStateRequired_x003E_k__BackingField>true</_x003C_IssuedStateRequired_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
<_x003C_OrganizationRequired_x003E_k__BackingField>true</_x003C_OrganizationRequired_x003E_k__BackingField>
</IdDocumentSpecificType>
<IdDocumentSpecificType>
<_x003C_ExpirationDateRequired_x003E_k__BackingField>true</_x003C_ExpirationDateRequired_x003E_k__BackingField>
<_x003C_GenericRegexValidator_x003E_k__BackingField>sample string 7</_x003C_GenericRegexValidator_x003E_k__BackingField>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_IssuedDateRequired_x003E_k__BackingField>true</_x003C_IssuedDateRequired_x003E_k__BackingField>
<_x003C_IssuedStateRequired_x003E_k__BackingField>true</_x003C_IssuedStateRequired_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
<_x003C_OrganizationRequired_x003E_k__BackingField>true</_x003C_OrganizationRequired_x003E_k__BackingField>
</IdDocumentSpecificType>
<IdDocumentSpecificType>
<_x003C_ExpirationDateRequired_x003E_k__BackingField>true</_x003C_ExpirationDateRequired_x003E_k__BackingField>
<_x003C_GenericRegexValidator_x003E_k__BackingField>sample string 7</_x003C_GenericRegexValidator_x003E_k__BackingField>
<_x003C_Id_x003E_k__BackingField>sample string 1</_x003C_Id_x003E_k__BackingField>
<_x003C_IssuedDateRequired_x003E_k__BackingField>true</_x003C_IssuedDateRequired_x003E_k__BackingField>
<_x003C_IssuedStateRequired_x003E_k__BackingField>true</_x003C_IssuedStateRequired_x003E_k__BackingField>
<_x003C_Name_x003E_k__BackingField>sample string 2</_x003C_Name_x003E_k__BackingField>
<_x003C_OrganizationRequired_x003E_k__BackingField>true</_x003C_OrganizationRequired_x003E_k__BackingField>
</IdDocumentSpecificType>
</_x003C_SpecificDocumentTypes_x003E_k__BackingField>
</IdDocumentTypeSearchResponse>