Show Menu

Identification Type

Identification Type

This API calls will get you the list of identification types.

post/API/v4/Register/GetIdentificationType

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

No request parameters

Reponse Parameters

IdentificationTypestring

Returned if successful List of identification types found. For each payment methods, the following parameters are returned:
IdentificationType—Unique identification types.

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
Errors - Displays an error message if the Property name Obligation Definition/value operation was unsuccessful. For more information, see API Error Message Appendix.
Success—Indicates whether the operation was successful. Returns True if the action was successful or False if it was not successful.

Sample Request:

sandbox.xapi.xtrm.com/API/v4/Register/GetIdentificationType

    {
    }
						

Sample Response:


{
	"IdentificationTypeResponse": {
		"IdentificationTypeResult": {
			"IdentificationType": {
				"IdentificationTypeDetails": [
					{
						"IdentificationType": "CitizenshipCard"
					},
					{
						"IdentificationType": "DriversLicense"
					},
					{
						"IdentificationType": "IdentityCard"
					},
					{
						"IdentificationType": "NationalIdentificationDocument"
					},
					{
						"IdentificationType": "NationalRegistrationIdentityCard"
					},
					{
						"IdentificationType": "Passport"
					},
					{
						"IdentificationType": "VotingCard"
					}
				]
			},
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}