@trinsic/api 3.0.2-preview1 → 3.1.0-preview1

package/docs/AadhaarLanguage.md

@@ -0,0 +1,37 @@
+
+# AadhaarLanguage
+
+The language used for the localized claims.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`languageCode` | string
+`languageName` | string
+
+## Example
+
+```typescript
+import type { AadhaarLanguage } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "languageCode": 05,
+  "languageName": Gujarati,
+} satisfies AadhaarLanguage
+
+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 AadhaarLanguage
+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/AadhaarLocalizedClaims.md

@@ -0,0 +1,38 @@
+
+# AadhaarLocalizedClaims
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`language` | [AadhaarLanguage](AadhaarLanguage.md)
+`name` | string
+`address` | [AadhaarAddress](AadhaarAddress.md)
+
+## Example
+
+```typescript
+import type { AadhaarLocalizedClaims } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "language": null,
+  "name": રાજેશ કુમાર,
+  "address": null,
+} satisfies AadhaarLocalizedClaims
+
+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 AadhaarLocalizedClaims
+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/AddRedirectUriRequest.md

@@ -0,0 +1,34 @@
+
+# AddRedirectUriRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`uri` | string
+
+## Example
+
+```typescript
+import type { AddRedirectUriRequest } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "uri": null,
+} satisfies AddRedirectUriRequest
+
+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 AddRedirectUriRequest
+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/AddRedirectUriResponse.md

@@ -0,0 +1,34 @@
+
+# AddRedirectUriResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+
+## Example
+
+```typescript
+import type { AddRedirectUriResponse } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+} satisfies AddRedirectUriResponse
+
+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 AddRedirectUriResponse
+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/Address.md

@@ -0,0 +1,49 @@
+
+# Address
+
+Address information for an individual
+
+## Properties
+
+Name | Type
+------------ | -------------
+`line1` | string
+`line2` | string
+`line3` | string
+`city` | string
+`subdivision` | string
+`postalCode` | string
+`country` | string
+`fullAddress` | string
+
+## Example
+
+```typescript
+import type { Address } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "line1": null,
+  "line2": null,
+  "line3": null,
+  "city": null,
+  "subdivision": null,
+  "postalCode": null,
+  "country": null,
+  "fullAddress": null,
+} satisfies Address
+
+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 Address
+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/AppleWalletInput.md

@@ -0,0 +1,36 @@
+
+# AppleWalletInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`exchangeMechanism` | [MdlExchangeMechanism](MdlExchangeMechanism.md)
+`previewRaw18013Request` | [Raw18013RequestInput](Raw18013RequestInput.md)
+
+## Example
+
+```typescript
+import type { AppleWalletInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "exchangeMechanism": null,
+  "previewRaw18013Request": null,
+} satisfies AppleWalletInput
+
+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 AppleWalletInput
+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/AppleWalletProviderOutput.md

@@ -0,0 +1,35 @@
+
+# AppleWalletProviderOutput
+
+Exposed properties for the `apple-wallet` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`rawMdlOutput` | [MdlOutput](MdlOutput.md)
+
+## Example
+
+```typescript
+import type { AppleWalletProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "rawMdlOutput": null,
+} satisfies AppleWalletProviderOutput
+
+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 AppleWalletProviderOutput
+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/AttachmentInfo.md

@@ -0,0 +1,40 @@
+
+# AttachmentInfo
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | string
+`contentType` | string
+`sizeBytes` | number
+
+## Example
+
+```typescript
+import type { AttachmentInfo } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "contentType": null,
+  "sizeBytes": null,
+} satisfies AttachmentInfo
+
+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 AttachmentInfo
+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/AttributeAvailability.md

@@ -0,0 +1,33 @@
+
+# AttributeAvailability
+
+Indicates when an attribute will be available in verification results.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { AttributeAvailability } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies AttributeAvailability
+
+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 AttributeAvailability
+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/AudkenniProviderOutput.md

@@ -0,0 +1,41 @@
+
+# AudkenniProviderOutput
+
+Exposed properties for the `audkenni` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`nationalRegisterId` | string
+`subjectId` | string
+`name` | string
+`dateOfBirth` | Date
+
+## Example
+
+```typescript
+import type { AudkenniProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "nationalRegisterId": 0101303369,
+  "subjectId": 2963785c-b8cc-490e-8d7e-054f7538383b,
+  "name": Gervimaður Asía,
+  "dateOfBirth": Thu Jan 31 00:00:00 UTC 1980,
+} satisfies AudkenniProviderOutput
+
+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 AudkenniProviderOutput
+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/AustriaHandySignaturProviderOutput.md

@@ -0,0 +1,37 @@
+
+# AustriaHandySignaturProviderOutput
+
+Exposed properties for the `a-at-handy-signatur-login` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+
+## Example
+
+```typescript
+import type { AustriaHandySignaturProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": John,
+  "lastName": Doe,
+} satisfies AustriaHandySignaturProviderOutput
+
+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 AustriaHandySignaturProviderOutput
+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/BelgiumIdCardProviderOutput.md

@@ -0,0 +1,41 @@
+
+# BelgiumIdCardProviderOutput
+
+Exposed properties for the `a-be-id-login` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`dateOfBirth` | Date
+`nationalRegisterNumber` | string
+
+## Example
+
+```typescript
+import type { BelgiumIdCardProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": John,
+  "lastName": Doe,
+  "dateOfBirth": Tue Dec 10 00:00:00 UTC 1985,
+  "nationalRegisterNumber": 83122412413,
+} satisfies BelgiumIdCardProviderOutput
+
+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 BelgiumIdCardProviderOutput
+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/BoliviaCiLookupInput.md

@@ -0,0 +1,36 @@
+
+# BoliviaCiLookupInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentNumber` | string
+`dateOfBirth` | Date
+
+## Example
+
+```typescript
+import type { BoliviaCiLookupInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentNumber": 123456789,
+  "dateOfBirth": Thu Mar 15 00:00:00 UTC 1990,
+} satisfies BoliviaCiLookupInput
+
+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 BoliviaCiLookupInput
+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/BoliviaCiProviderOutput.md

@@ -0,0 +1,43 @@
+
+# BoliviaCiProviderOutput
+
+Exposed properties for the `bolivia-ci-lookup` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`givenName` | string
+`familyName` | string
+`dateOfBirth` | Date
+`documentNumber` | string
+
+## Example
+
+```typescript
+import type { BoliviaCiProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullName": María Mamani,
+  "givenName": María,
+  "familyName": Mamani,
+  "dateOfBirth": Thu Mar 15 00:00:00 UTC 1990,
+  "documentNumber": 123456789,
+} satisfies BoliviaCiProviderOutput
+
+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 BoliviaCiProviderOutput
+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/BrazilCpfCheckInput.md

@@ -0,0 +1,38 @@
+
+# BrazilCpfCheckInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cpfNumber` | string
+`selfieImage` | string
+`selfieImageContentType` | string
+
+## Example
+
+```typescript
+import type { BrazilCpfCheckInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cpfNumber": null,
+  "selfieImage": null,
+  "selfieImageContentType": null,
+} satisfies BrazilCpfCheckInput
+
+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 BrazilCpfCheckInput
+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/BrazilDigitalCnhInput.md

@@ -0,0 +1,40 @@
+
+# BrazilDigitalCnhInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cpfNumber` | string
+`digitalCnhFile` | string
+`digitalCnhFileContentType` | string
+`facialBiometryPhoto` | string
+
+## Example
+
+```typescript
+import type { BrazilDigitalCnhInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cpfNumber": null,
+  "digitalCnhFile": null,
+  "digitalCnhFileContentType": null,
+  "facialBiometryPhoto": null,
+} satisfies BrazilDigitalCnhInput
+
+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 BrazilDigitalCnhInput
+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/CancelSessionResponse.md

@@ -0,0 +1,34 @@
+
+# CancelSessionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`session` | [Session](Session.md)
+
+## Example
+
+```typescript
+import type { CancelSessionResponse } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "session": null,
+} satisfies CancelSessionResponse
+
+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 CancelSessionResponse
+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)
+
+