Skip to content
GBG Documents & Biometrics Documentation

API changes by version

Version REST API member Parameter Description of changes
2.24.49 DocumentClass MedicalCard enumeration New. An identity document, issued by the Local Health Board, Primary Care Trust, Health Board or Health and Social Services Board used to access primary medical services.
2.24.49 DocumentClass MunicipalIdentification enumeration New. An identity document that lets cardholders access local service that might otherwise be unavailable.
2.18.0 GET/Document/INSTANCEID. DocumentAlerts/DocumentAlert Model New. Gets the model used in the authenticator
2.17.0 POST Document/Instance TamperSensitivity New. Gets or sets a separate tamper-related sensitivity level for the document, which indicates the relative importance of tampering test results compared to the normal result
2.17.0 GET /Document/INSTANCEID TamperResult New. Indicates the tamper-related result of the overall document authentication
2.14.2 PUT Document/INSTANCEID/Data DocumentData method New. Enables the re-capture and re-upload of data from the back side of a document that contains a barcode (1D or 2D), MRZ, or magstripe.
2.9.0 GET Document/INSTANCEID/ Field/Image quality New. Enables a user to specify the quality of an image to accept. RANGE is 1-100. DEFAULT is 50.
2.9.0 GET Document/Instance/Activity New endpoint. Returns an authorized user’s activity for a Document
2.8.1 DocumentType IssuerType New property that identifies the issuing authority type for the document
2.5.0 DocumentClass Military New document class. An identity document issued by a government agency to grant or restrict access to military information, locations, or privileges.
2.1.0 PUT Document/Instance Image New method. Replaces an image in a document instance. Note The image must first be posted before it can be replaced.
2.0.1 POST DocumentImage Metrics New metrics parameter. Calculates the amount of glare or sharpness present on an image. True | False (DEFAULT)
2.0.1 GET DocumentImageMetrics New endpoint. Returns any available metadata, including the quality metrics of sharpness and glare, if requested for a previously posted image.
2.0.1 GET Document Modified to include returning any available metadata, including the quality metrics of sharpness and glare, if requested for a previously posted image.
Version .NET SDK member Parameter Description of changes
2.24.49 DocumentClass MedicalCard enumeration New. An identity document, issued by the Local Health Board, Primary Care Trust, Health Board or Health and Social Services Board used to access primary medical services.
2.24.49 DocumentClass MunicipalIdentification enumeration New. An identity document that lets cardholders access local service that might otherwise be unavailable.
2.18.0 GetDocument/Document/ DocumentAlerts/DocumentAlert Model New. Gets the model used in the authenticator
2.17.0 PostDocumentInstance/ DocumentSettings TamperSensitivity New. Gets or sets a separate tamper-related sensitivity level for the document, which indicates the relative importance of tampering test results compared to the normal result
2.17.0 GetDocument/ Document TamperResult New. Indicates the tamper-related result of the overall document authentication
2.16.17 AssureIDServiceClient GetDocument method Modified to allow passing an optional value for a non-English Accept-Language header (for example, es)
2.16.17 AssureIDServiceClient GetDocumentClassification method Modified to allow passing an optional value for the Accept-Language header (for example, es)
2.14.2 AssureIDServiceClient PUT DocumentData method New. Enables the re-capture and re-upload of data from the back side of a document that contains a barcode (1D or 2D), MRZ, or magstripe
2.9.0 GetDocumentFieldImage method quality New. Enables a user to specify the quality of an image to accept. RANGE is 1-100. DEFAULT is 50.
2.9.0 GetDocumentImage method quality New. Enables a user to specify the quality of an image to accept. RANGE is 1-100. DEFAULT is 50.
2.9.0 UserAuthorization class New. Describes an authorized user’s activity for a Document
2.9.0 AssureIDSessionClient GetDocumentActivity method New. Returns authorized user activity for a Document
2.8.1 DocumentType IssuerType New. Property that identifies the issuing authority type for the document
2.5.0 DocumentClass Military New document class. An identity document issued by a government agency to grant or restrict access to military information, locations, or privileges
2.0.1 DocumentImage class GlareMetric property New. If specified, indicates the relative amount of glare detected on an image, on a scale of 0 (obscured by glare) to 100 (no glare detected).
2.0.1 DocumentImage class SharpnessMetric property New. If specified, indicates the relative sharpness of this image, on a scale of 0 (blurry) to 100 (sharp).
2.0.1 AssureIDSessionClient GetDocument method Modified. Returns metrics via the DocumentImage class.
2.0.1 AssureIDSessionClient GetDocumentImage Metrics method New parameter. Returns metrics via the DocumentImage class.
2.0.1 AssureIDSessionClient PostDocumentImage method New parameter. If specified, calculates the quality metrics of sharpness and glare on an image. True | False (default)
1.9.0 DocumentSettings ProcessMode.Barcode New enumeration. Only the document’s barcode is processed.
1.9.0 DocumentClass WeaponLicense. TribalIdentification. VoterIdentification New document types.
1.8.6 CroppingMode ImageCroppingMode New enumeration
1.8.6 CroppingExpectedSize ImageCroppingExpectedSize New enumeration
1.8.5 CroppingMode New enumeration value Always
1.7.0 CroppingMode ImageCroppingMode New enumeration
1.7.0 CroppingExpectedSize ImageCroppingExpectedSize New enumeration
1.7.0 DocumentSettings ImageCroppingMode New property
1.7.0 DocumentSettings ImageCroppingExpectedSize New property
1.7.0 AssureIDSessionClient PostDocumentImage Modified. Image may now be uncropped without accurate resolution specified if Automatic cropping was enabled when the document instance was created.
1.5.0 GET DocumentTypes Number of query string arguments changed New SubscriptionId query string argument. If supplied, the value of this argument must be set to a valid subscription identifier that is obtained using the new GET Subscriptions operation.
1.5.0 GET Subscriptions New operation New
1.5.0 Document class Improved New ProcessMode read-only property that yields a DocumentProcessMode enumeration value. Added a Subscription read-only property that yields a Subscription object
1.5.0 DocumentClassification class Improved New PresentationChanged read-only property
1.5.0 DocumentDataSource enumeration Improved New Other member
1.5.0 DocumentField class Improved New DataSource read-only property that yields a DocumentDataSource enumeration value
1.5.0 DocumentProcessMode enumeration Added New enumeration
1.5.0 DocumentSettings class Improved Modified. Renamed the ManualDocumentTypeId read/write property to ManualDocumentType. Note The value of this property must be set to a valid DocumentType object that is obtained from the service using the GET DocumentType operation.
1.5.0 ProcessMode Added New ProcessMode read/write property containing a DocumentProcessMode enumeration value for specifying how a document shall be processed. Added a SubscriptionId read/write property for specifying the subscription that shall be used for document processing. Note The value of this property must be set to a valid Subscription identifier (Guid) that is obtained from the service using the GET Subscriptions operation.
1.5.0 Subscription class Added New class
1.4.0 GET DocumentChipData Added New operation
1.4.0 POST DocumentChipData Added New operation
1.4.0 GET DocumentData Number of query string arguments Modified. Removed the DocumentDataSubType query string argument. It was used to specify contactless chip data items. The new GET DocumentChipData operation can be used for this purpose.
1.4.0 POST DocumentData Number of query string arguments Modified. Removed the DocumentDataSubType query string argument. It was used to specify contactless chip data items. The new POST DocumentChipData operation can be used for this purpose.
1.4.0 GET DocumentImage Query string argument Modified. Renamed the DeviceLight query string argument to LightSource.
1.4.0 POST DocumentImage Query string argument Modified. Renamed the DeviceLight query string argument to LightSource.
1.4.0 POST DocumentInstance New operation New operation.
1.4.0 GET DocumentLog New operation New operation.
1.4.0 AssureIDServiceClient class Improved New. Added a ServiceAddress read-only property.
1.4.0 ChipAuthentication class Changed Modified the return type of the Result read-only property from AuthenticationResult to ChipAuthenticationResult
1.4.0 DeviceInfo class Improved Added a constructor overload accepting SensorType argument and added new SensorType read-only property
1.4.0 DeviceType class Improved New constructor overload accepting SensorType argument and added new SensorType read-only property
1.4.0 Document class Changed/enhanced Modified. Renamed the Id read-only property to InstanceId. Added an AuthenticationSensitivity read-only property
1.4.0 DocumentClassification class Changed Removed the GenericIssuerCode and GenericIssuerName read-only properties. Note Use the read-only Type.Issuer and Type.IssuerName properties instead.
1.4.0 DocumentDataField class Improved New IsImage read-only property.
1.4.0 DocumentField class Improved New IsImage read-only property.
1.4.0 DocumentImage class Changed Modified the return type of the Light read-only property from the DeviceLight enumeration to the LightSource enumeration.
1.4.0 DocumentImageType class Changed Modified the return type of the Light read-only property from the DeviceLight enumeration to the LightSource enumeration.
1.4.0 ChipAuthenticationResult enumeration Added New enumeration
1.4.0 ChipAuthenticationType enumeration Changed/enhanced New. Added the following members: PassiveAuthentication. SupplementalAuthentication. Removed the following members: CountrySignerRevocation. DocumentSignerRevocation. DocumentSignerValidation. HashValueValidation. SignatureValidation
1.4.0 ChipDataGroup enumeration Added New enumeration.
1.4.0 DeviceLight enumeration Removed Deleted. This enumeration is obsolete; use LightSource enumeration instead.
1.4.0 DocumentDataSubType enumeration Removed Deleted. This enumeration is obsolete; use ChipDataGroup enumeration instead.
1.4.0 DocumentDataType enumeration Changed Deleted the ContactlessChip member.
1.4.0 LightSource enumeration Added New enumeration.