@trinsic/api 3.0.2-preview1 → 3.1.0-preview1

package/docs/MatchData.md

@@ -0,0 +1,55 @@
+
+# MatchData
+
+Match results for the data being matched against.              This applies to Providers which operate based on matching data / biometrics against a government database, returning match scores or results as opposed to the data itself.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`nationalIdNumber` | [Match](Match.md)
+`fullName` | [Match](Match.md)
+`givenName` | [Match](Match.md)
+`middleName` | [Match](Match.md)
+`familyName` | [Match](Match.md)
+`sex` | [Match](Match.md)
+`dateOfBirth` | [Match](Match.md)
+`phoneNumber` | [Match](Match.md)
+`faceMatch` | [Match](Match.md)
+`liveness` | [Match](Match.md)
+`imageAuthenticity` | [Match](Match.md)
+
+## Example
+
+```typescript
+import type { MatchData } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "nationalIdNumber": null,
+  "fullName": null,
+  "givenName": null,
+  "middleName": null,
+  "familyName": null,
+  "sex": null,
+  "dateOfBirth": null,
+  "phoneNumber": null,
+  "faceMatch": null,
+  "liveness": null,
+  "imageAuthenticity": null,
+} satisfies MatchData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MatchData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MdlExchangeMechanism.md

@@ -0,0 +1,32 @@
+
+# MdlExchangeMechanism
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { MdlExchangeMechanism } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies MdlExchangeMechanism
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MdlExchangeMechanism
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MdlOutput.md

@@ -0,0 +1,40 @@
+
+# MdlOutput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`iacaRootCertificate` | [MdlOutputCertificateData](MdlOutputCertificateData.md)
+`documentSignerCertificate` | [MdlOutputCertificateData](MdlOutputCertificateData.md)
+`documentType` | string
+`nameSpaces` | { [key: string]: { [key: string]: MdlOutputFieldData; }; }
+
+## Example
+
+```typescript
+import type { MdlOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "iacaRootCertificate": null,
+  "documentSignerCertificate": null,
+  "documentType": org.iso.18013.5.1.mDL,
+  "nameSpaces": {"org.iso.18013.5.1":{"family_name":{"type":"String","value":"DOE"},"given_name":{"type":"String","value":"JOHN"},"birth_date":{"type":"String","value":"2000-03-27"},"age_over_21":{"type":"Boolean","value":"true"}}},
+} satisfies MdlOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MdlOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MdlOutputCertificateData.md

@@ -0,0 +1,42 @@
+
+# MdlOutputCertificateData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`serialNumber` | string
+`commonName` | string
+`stateOrProvinceName` | string
+`notBefore` | Date
+`notAfter` | Date
+
+## Example
+
+```typescript
+import type { MdlOutputCertificateData } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "serialNumber": 535868140170056787981774412188464491855209169584,
+  "commonName": California DMV IACA Root,
+  "stateOrProvinceName": US-CA,
+  "notBefore": 2023-03-01T17:17:39Z,
+  "notAfter": 2033-01-07T17:17:39Z,
+} satisfies MdlOutputCertificateData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MdlOutputCertificateData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MdlOutputFieldData.md

@@ -0,0 +1,36 @@
+
+# MdlOutputFieldData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | [MdlOutputFieldDataType](MdlOutputFieldDataType.md)
+`value` | string
+
+## Example
+
+```typescript
+import type { MdlOutputFieldData } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "value": 123 Fake St,
+} satisfies MdlOutputFieldData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MdlOutputFieldData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MdlOutputFieldDataType.md

@@ -0,0 +1,32 @@
+
+# MdlOutputFieldDataType
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { MdlOutputFieldDataType } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies MdlOutputFieldDataType
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MdlOutputFieldDataType
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MexicoCurpInput.md

@@ -0,0 +1,34 @@
+
+# MexicoCurpInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`curp` | string
+
+## Example
+
+```typescript
+import type { MexicoCurpInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "curp": null,
+} satisfies MexicoCurpInput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MexicoCurpInput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MexicoCurpProviderOutput.md

@@ -0,0 +1,35 @@
+
+# MexicoCurpProviderOutput
+
+Exposed properties for the `mexico-curp-lookup` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`curpStatus` | string
+
+## Example
+
+```typescript
+import type { MexicoCurpProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "curpStatus": AN,
+} satisfies MexicoCurpProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MexicoCurpProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MitIdProviderOutput.md

@@ -0,0 +1,55 @@
+
+# MitIdProviderOutput
+
+Exposed properties for the `denmark-mitid` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`dateOfBirth` | Date
+`uniqueIdentifier` | string
+`authenticationAssuranceLevel` | string
+`identityAuthenticationLevel` | string
+`levelOfAssurance` | string
+`identificationSource` | string
+`civilRegistrationNumber` | string
+`organizationName` | string
+`organizationNumber` | string
+`authorizedRepresentativeNumber` | string
+
+## Example
+
+```typescript
+import type { MitIdProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullName": Ove Henriksen,
+  "dateOfBirth": Sun Aug 15 00:00:00 UTC 1943,
+  "uniqueIdentifier": 8ba191ec-64b1-41c1-b622-4b8c14c34428,
+  "authenticationAssuranceLevel": https://data.gov.dk/concept/core/nsis/Substantial,
+  "identityAuthenticationLevel": https://data.gov.dk/concept/core/nsis/Substantial,
+  "levelOfAssurance": https://data.gov.dk/concept/core/nsis/Substantial,
+  "identificationSource": private,
+  "civilRegistrationNumber": 01311985-1234,
+  "organizationName": Dansk Standard,
+  "organizationNumber": DK12345678,
+  "authorizedRepresentativeNumber": 8ba191ec-64b1-41c1-b622-4b8c14c34428,
+} satisfies MitIdProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MitIdProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MobileCarrier.md

@@ -0,0 +1,32 @@
+
+# MobileCarrier
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { MobileCarrier } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies MobileCarrier
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MobileCarrier
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MobileIdInput.md

@@ -0,0 +1,38 @@
+
+# MobileIdInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`mobileIdPhoneNumber` | string
+`mobileIdNationalIdentityNumber` | string
+`mobileIdLanguage` | [MobileIdLanguage](MobileIdLanguage.md)
+
+## Example
+
+```typescript
+import type { MobileIdInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "mobileIdPhoneNumber": null,
+  "mobileIdNationalIdentityNumber": null,
+  "mobileIdLanguage": null,
+} satisfies MobileIdInput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MobileIdInput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MobileIdLanguage.md

@@ -0,0 +1,32 @@
+
+# MobileIdLanguage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { MobileIdLanguage } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies MobileIdLanguage
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MobileIdLanguage
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MobileIdProviderOutput.md

@@ -0,0 +1,51 @@
+
+# MobileIdProviderOutput
+
+Exposed properties for the `mobile-id` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`givenName` | string
+`familyName` | string
+`dateOfBirth` | Date
+`sex` | string
+`country` | string
+`identityType` | string
+`personalCode` | string
+`serialNumber` | string
+`certificateSubject` | string
+
+## Example
+
+```typescript
+import type { MobileIdProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "givenName": MARI,
+  "familyName": TAMM,
+  "dateOfBirth": Tue Jan 01 00:00:00 UTC 1985,
+  "sex": Female,
+  "country": EE,
+  "identityType": PNO,
+  "personalCode": 48501010014,
+  "serialNumber": PNOEE-48501010014,
+  "certificateSubject": SERIALNUMBER=PNOEE-48501010014, G=MARI, SN=TAMM, CN="TAMM,MARI,48501010014", C=EE,
+} satisfies MobileIdProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MobileIdProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MobileOperatingSystem.md

@@ -0,0 +1,32 @@
+
+# MobileOperatingSystem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { MobileOperatingSystem } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies MobileOperatingSystem
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MobileOperatingSystem
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/NetherlandsIdinAddress.md

@@ -0,0 +1,42 @@
+
+# NetherlandsIdinAddress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`street` | string
+`houseNumber` | string
+`postalCode` | string
+`city` | string
+`countryCode` | string
+
+## Example
+
+```typescript
+import type { NetherlandsIdinAddress } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "street": Drieslag,
+  "houseNumber": 51,
+  "postalCode": 6832AM,
+  "city": Arnhem,
+  "countryCode": NL,
+} satisfies NetherlandsIdinAddress
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as NetherlandsIdinAddress
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/NetherlandsIdinProviderOutput.md

@@ -0,0 +1,53 @@
+
+# NetherlandsIdinProviderOutput
+
+Exposed properties for the `netherlands-idin` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`authorityId` | string
+`authorityName` | string
+`customerId` | string
+`initials` | string
+`familyName` | string
+`address` | [NetherlandsIdinAddress](NetherlandsIdinAddress.md)
+`birthDate` | Date
+`gender` | string
+`phoneNumber` | string
+`email` | string
+
+## Example
+
+```typescript
+import type { NetherlandsIdinProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "authorityId": INGBNL2A,
+  "authorityName": ING,
+  "customerId": NLINGBG344XBYRN9O+Zu7EK9ajC8Ta19fe0xDYfwudOnKRirMopP9rgG/GfV8L1Ck3UWqgYq8dNhKztgp3PRYOelbTJQ==,
+  "initials": J,
+  "familyName": De Wit,
+  "address": null,
+  "birthDate": Mon Jan 15 00:00:00 UTC 1990,
+  "gender": Male,
+  "phoneNumber": +31612345678,
+  "email": jan.dewit@example.nl,
+} satisfies NetherlandsIdinProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as NetherlandsIdinProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/NigeriaNinBiometric2Input.md

@@ -0,0 +1,38 @@
+
+# NigeriaNinBiometric2Input
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`idNumber` | string
+`livenessImages` | Array<string>
+`testSelfie` | string
+
+## Example
+
+```typescript
+import type { NigeriaNinBiometric2Input } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "idNumber": null,
+  "livenessImages": null,
+  "testSelfie": null,
+} satisfies NigeriaNinBiometric2Input
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as NigeriaNinBiometric2Input
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+