@trinsic/api 3.0.1 → 3.1.0-preview1

package/docs/IntegrationCapability.md

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

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

@@ -0,0 +1,39 @@
+
+# IntegrationStep
+
+A step to perform in the process of executing a Direct Provider Session
+
+## Properties
+
+Name | Type
+------------ | -------------
+`method` | [IntegrationLaunchMethod](IntegrationLaunchMethod.md)
+`content` | string
+`refresh` | [StepRefreshInfo](StepRefreshInfo.md)
+
+## Example
+
+```typescript
+import type { IntegrationStep } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "method": null,
+  "content": https://verify.trinsic.id/api/session/launch?clientToken=...,
+  "refresh": null,
+} satisfies IntegrationStep
+
+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 IntegrationStep
+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/ItsmeProviderOutput.md

@@ -0,0 +1,43 @@
+
+# ItsmeProviderOutput
+
+Exposed properties for the `a-itsme-login` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`dateOfBirth` | Date
+`hashedNationalRegisterNumber` | string
+`nationalRegisterNumber` | string
+
+## Example
+
+```typescript
+import type { ItsmeProviderOutput } 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,
+  "hashedNationalRegisterNumber": 5d17e158243dff0bd79fbfd06b27b80d04a40a6a0425e1bbb474c7634a2918f7,
+  "nationalRegisterNumber": 83122412413,
+} satisfies ItsmeProviderOutput
+
+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 ItsmeProviderOutput
+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/KenyaNidBiometric2Input.md

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

@@ -0,0 +1,44 @@
+
+# KenyaNidInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`middleName` | string
+`lastName` | string
+`dateOfBirth` | Date
+`gender` | string
+`nationalIdNumber` | string
+
+## Example
+
+```typescript
+import type { KenyaNidInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": null,
+  "middleName": null,
+  "lastName": null,
+  "dateOfBirth": null,
+  "gender": null,
+  "nationalIdNumber": null,
+} satisfies KenyaNidInput
+
+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 KenyaNidInput
+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/KenyaNidLookup2Address.md

@@ -0,0 +1,43 @@
+
+# KenyaNidLookup2Address
+
+Represents a Kenya address as stored in the IPRS (Integrated Population Registration System) database.              The structure reflects the pre-2010 provincial administration system: District > Division > Location. Since the 2010 constitutional change to counties, these legacy administrative divisions are still maintained in IPRS records for historical continuity.              The raw address from IPRS is a newline-separated string with labeled administrative components. Example format:              ``` P O BOX 41842 NAIROBI PARLIAMENT BUILDINGS LOCATION - CITY SQUARE DIVISION - CENTRAL DISTRICT - NAIROBI ```              The first lines contain informal address details (village, P.O. Box) while the suffixed lines contain official administrative designations prefixed with labels like \"LOCATION -\", \"DIVISION -\", \"DISTRICT -\".
+
+## Properties
+
+Name | Type
+------------ | -------------
+`district` | string
+`division` | string
+`location` | string
+`additionalLines` | Array<string>
+`raw` | string
+
+## Example
+
+```typescript
+import type { KenyaNidLookup2Address } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "district": NAIROBI,
+  "division": CENTRAL,
+  "location": CITY SQUARE,
+  "additionalLines": ["P O BOX 41842 NAIROBI","PARLIAMENT BUILDINGS"],
+  "raw": P O BOX 41842 NAIROBI\nPARLIAMENT BUILDINGS\nLOCATION - CITY SQUARE\nDIVISION - CENTRAL\nDISTRICT - NAIROBI,
+} satisfies KenyaNidLookup2Address
+
+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 KenyaNidLookup2Address
+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/KenyaNidLookup2Input.md

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

@@ -0,0 +1,55 @@
+
+# KenyaNidLookup2ProviderOutput
+
+Exposed properties for the `kenya-nid-lookup-2` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`surname` | string
+`otherName` | string
+`sex` | string
+`dateOfBirth` | Date
+`citizenship` | string
+`idNumber` | string
+`serialNumber` | string
+`dateOfIssue` | Date
+`placeOfBirth` | [KenyaNidLookup2Address](KenyaNidLookup2Address.md)
+`placeOfResidence` | [KenyaNidLookup2Address](KenyaNidLookup2Address.md)
+
+## Example
+
+```typescript
+import type { KenyaNidLookup2ProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": JUMA,
+  "surname": ODHIAMBO,
+  "otherName": OTIENO,
+  "sex": Male,
+  "dateOfBirth": Tue Jan 01 00:00:00 UTC 1985,
+  "citizenship": Kenyan,
+  "idNumber": 12345678,
+  "serialNumber": 98765432,
+  "dateOfIssue": Tue Jun 15 00:00:00 UTC 2010,
+  "placeOfBirth": null,
+  "placeOfResidence": null,
+} satisfies KenyaNidLookup2ProviderOutput
+
+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 KenyaNidLookup2ProviderOutput
+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/KenyaNidMatch2Input.md

@@ -0,0 +1,44 @@
+
+# KenyaNidMatch2Input
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`idNumber` | string
+`givenName` | string
+`familyName` | string
+`middleName` | string
+`dateOfBirth` | Date
+`sex` | [KenyaNidMatch2InputSex](KenyaNidMatch2InputSex.md)
+
+## Example
+
+```typescript
+import type { KenyaNidMatch2Input } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "idNumber": null,
+  "givenName": null,
+  "familyName": null,
+  "middleName": null,
+  "dateOfBirth": null,
+  "sex": null,
+} satisfies KenyaNidMatch2Input
+
+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 KenyaNidMatch2Input
+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/KenyaNidMatch2InputSex.md

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

@@ -0,0 +1,44 @@
+
+# KoreaTelcoMatchInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`phoneNumber` | string
+`fullName` | string
+`dateOfBirth` | Date
+`sex` | [KoreaTelcoMatchSex](KoreaTelcoMatchSex.md)
+`carrier` | [MobileCarrier](MobileCarrier.md)
+`operatingSystem` | [MobileOperatingSystem](MobileOperatingSystem.md)
+
+## Example
+
+```typescript
+import type { KoreaTelcoMatchInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "phoneNumber": null,
+  "fullName": null,
+  "dateOfBirth": null,
+  "sex": null,
+  "carrier": null,
+  "operatingSystem": null,
+} satisfies KoreaTelcoMatchInput
+
+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 KoreaTelcoMatchInput
+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/KoreaTelcoMatchProviderOutput.md

@@ -0,0 +1,39 @@
+
+# KoreaTelcoMatchProviderOutput
+
+Exposed properties for the `korea-telco-match` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`phoneNumber` | string
+`teleType` | string
+`resultCode` | string
+
+## Example
+
+```typescript
+import type { KoreaTelcoMatchProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "phoneNumber": 01012345678,
+  "teleType": Skt,
+  "resultCode": 0000,
+} satisfies KoreaTelcoMatchProviderOutput
+
+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 KoreaTelcoMatchProviderOutput
+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/KoreaTelcoMatchSex.md

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

@@ -0,0 +1,69 @@
+
+# LaWalletProviderOutput
+
+Exposed properties for the `usa-louisiana-wallet` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`driversLicenseNumber` | string
+`issueDate` | Date
+`expirationDate` | Date
+`auditNumber` | string
+`licenseStatus` | string
+`licenseClass` | string
+`firstName` | string
+`middleName` | string
+`lastName` | string
+`dateOfBirth` | Date
+`sex` | string
+`addressLine1` | string
+`addressLine2` | string
+`addressCity` | string
+`addressState` | string
+`addressZip` | string
+`county` | string
+`coarseAge` | string
+
+## Example
+
+```typescript
+import type { LaWalletProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "driversLicenseNumber": 001234567,
+  "issueDate": Tue Jun 30 00:00:00 UTC 2020,
+  "expirationDate": Sun Jun 30 00:00:00 UTC 2030,
+  "auditNumber": 1234,
+  "licenseStatus": VALID,
+  "licenseClass": E,
+  "firstName": JOHN,
+  "middleName": JACOB,
+  "lastName": DOE,
+  "dateOfBirth": Mon Jan 15 00:00:00 UTC 1990,
+  "sex": Male,
+  "addressLine1": 123 MAIN ST,
+  "addressLine2": #5,
+  "addressCity": BATON ROUGE,
+  "addressState": LA,
+  "addressZip": 70801,
+  "county": 17,
+  "coarseAge": Over 21,
+} satisfies LaWalletProviderOutput
+
+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 LaWalletProviderOutput
+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/LatviaEparakstsMobileProviderOutput.md

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