@trinsic/api 3.0.1 → 3.1.0-preview1

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)
+
+

package/docs/ChinaResidentIdMatchInput.md

@@ -0,0 +1,40 @@
+
+# ChinaResidentIdMatchInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`dateOfBirth` | Date
+`nationalIdNumber` | string
+`consent` | boolean
+
+## Example
+
+```typescript
+import type { ChinaResidentIdMatchInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullName": null,
+  "dateOfBirth": null,
+  "nationalIdNumber": null,
+  "consent": null,
+} satisfies ChinaResidentIdMatchInput
+
+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 ChinaResidentIdMatchInput
+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/ChinaResidentIdMatchOutput.md

@@ -0,0 +1,39 @@
+
+# ChinaResidentIdMatchOutput
+
+Exposed properties for the `china-resident-id-match` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`dateOfBirth` | Date
+`residentIdNumber` | string
+
+## Example
+
+```typescript
+import type { ChinaResidentIdMatchOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullName": 陈明志,
+  "dateOfBirth": Thu Jan 31 00:00:00 UTC 1980,
+  "residentIdNumber": 110102198001318811,
+} satisfies ChinaResidentIdMatchOutput
+
+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 ChinaResidentIdMatchOutput
+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/ColombiaCcLookupInput.md

@@ -0,0 +1,36 @@
+
+# ColombiaCcLookupInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentNumber` | string
+`issueDate` | Date
+
+## Example
+
+```typescript
+import type { ColombiaCcLookupInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentNumber": 1234567890,
+  "issueDate": Fri Oct 31 00:00:00 UTC 2025,
+} satisfies ColombiaCcLookupInput
+
+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 ColombiaCcLookupInput
+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/ColombiaCcProviderOutput.md

@@ -0,0 +1,53 @@
+
+# ColombiaCcProviderOutput
+
+Exposed properties for the `colombia-cc-lookup` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`givenName` | string
+`familyName` | string
+`dateOfBirth` | Date
+`sex` | string
+`isAlive` | boolean
+`documentNumber` | string
+`expeditionDate` | Date
+`expeditionPlace` | [ColombiaExpeditionPlace](ColombiaExpeditionPlace.md)
+`arrayName` | Array<string>
+
+## Example
+
+```typescript
+import type { ColombiaCcProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullName": JUAN CARLOS PEREZ GOMEZ,
+  "givenName": JUAN CARLOS,
+  "familyName": PEREZ GOMEZ,
+  "dateOfBirth": Tue Jan 15 00:00:00 UTC 1985,
+  "sex": Male,
+  "isAlive": true,
+  "documentNumber": 1234567890,
+  "expeditionDate": Tue Mar 10 00:00:00 UTC 2020,
+  "expeditionPlace": null,
+  "arrayName": ["PEREZ","GOMEZ","JUAN","CARLOS"],
+} satisfies ColombiaCcProviderOutput
+
+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 ColombiaCcProviderOutput
+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/ColombiaExpeditionPlace.md

@@ -0,0 +1,37 @@
+
+# ColombiaExpeditionPlace
+
+Place of expedition (issue) for the Colombia Cédula de Ciudadanía (CC) as recorded by the Registraduría Nacional del Estado Civil (National Civil Registry).              Colombia uses a two-level administrative hierarchy for place of issue: municipality (municipio) within department (departamento).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`municipality` | string
+`department` | string
+
+## Example
+
+```typescript
+import type { ColombiaExpeditionPlace } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "municipality": BOGOTA D.C.,
+  "department": BOGOTA,
+} satisfies ColombiaExpeditionPlace
+
+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 ColombiaExpeditionPlace
+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/ConnectIdAddress.md

@@ -0,0 +1,42 @@
+
+# ConnectIdAddress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`streetAddress` | string
+`locality` | string
+`region` | string
+`country` | string
+`postalCode` | string
+
+## Example
+
+```typescript
+import type { ConnectIdAddress } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "streetAddress": L 7 SE 3 17 Jones St,
+  "locality": North Sydney,
+  "region": NSW,
+  "country": AUS,
+  "postalCode": 2060,
+} satisfies ConnectIdAddress
+
+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 ConnectIdAddress
+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/ConnectIdAgeVerification.md

@@ -0,0 +1,36 @@
+
+# ConnectIdAgeVerification
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`over18` | boolean
+`trustFramework` | string
+
+## Example
+
+```typescript
+import type { ConnectIdAgeVerification } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "over18": true,
+  "trustFramework": au_connectid,
+} satisfies ConnectIdAgeVerification
+
+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 ConnectIdAgeVerification
+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/ConnectIdProviderOutput.md

@@ -0,0 +1,53 @@
+
+# ConnectIdProviderOutput
+
+Exposed properties for the `australia-connect-id` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`birthdate` | Date
+`givenName` | string
+`middleName` | string
+`familyName` | string
+`phoneNumber` | string
+`email` | string
+`sub` | string
+`ageVerification` | [ConnectIdAgeVerification](ConnectIdAgeVerification.md)
+`transaction` | string
+`address` | [ConnectIdAddress](ConnectIdAddress.md)
+
+## Example
+
+```typescript
+import type { ConnectIdProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "birthdate": Thu Jan 31 00:00:00 UTC 1985,
+  "givenName": John,
+  "middleName": Albert,
+  "familyName": Smith,
+  "phoneNumber": +61271111222,
+  "email": johnasmith@example.com,
+  "sub": abcdefg123456,
+  "ageVerification": null,
+  "transaction": qaTTTTuhVnTck8zQlba4pFW2jo55555UfIoOEYv8sJq,
+  "address": null,
+} satisfies ConnectIdProviderOutput
+
+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 ConnectIdProviderOutput
+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)
+
+