@trinsic/api 3.0.2-preview1 → 3.1.0-preview1

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

package/docs/LatviaEparakstsProviderOutput.md

@@ -0,0 +1,39 @@
+
+# LatviaEparakstsProviderOutput
+
+Exposed properties for the `a-lv-eparaksts-id-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 { LatviaEparakstsProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": John,
+  "lastName": Doe,
+  "personalCode": 300680-15055,
+} satisfies LatviaEparakstsProviderOutput
+
+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 LatviaEparakstsProviderOutput
+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/ListProvidersResponse.md

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

@@ -0,0 +1,37 @@
+
+# ListRedirectUrisResponse
+
+Response from listing redirect URIs within an environment.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`uris` | [Array<RedirectUriResponse>](RedirectUriResponse.md)
+`more` | boolean
+
+## Example
+
+```typescript
+import type { ListRedirectUrisResponse } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "uris": null,
+  "more": true,
+} satisfies ListRedirectUrisResponse
+
+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 ListRedirectUrisResponse
+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/ListSessionsResponse.md

@@ -0,0 +1,38 @@
+
+# ListSessionsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sessions` | [Array<Session>](Session.md)
+`total` | number
+`more` | boolean
+
+## Example
+
+```typescript
+import type { ListSessionsResponse } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sessions": null,
+  "total": 101,
+  "more": true,
+} satisfies ListSessionsResponse
+
+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 ListSessionsResponse
+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/ListVerificationProfilesResponse.md

@@ -0,0 +1,36 @@
+
+# ListVerificationProfilesResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`verificationProfiles` | [Array<VerificationProfileResponse>](VerificationProfileResponse.md)
+`more` | boolean
+
+## Example
+
+```typescript
+import type { ListVerificationProfilesResponse } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "verificationProfiles": null,
+  "more": true,
+} satisfies ListVerificationProfilesResponse
+
+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 ListVerificationProfilesResponse
+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/LithuaniaIdCardProviderOutput.md

@@ -0,0 +1,41 @@
+
+# LithuaniaIdCardProviderOutput
+
+Exposed properties for the `a-lt-id-login` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`dateOfBirth` | Date
+`personalCode` | string
+
+## Example
+
+```typescript
+import type { LithuaniaIdCardProviderOutput } 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,
+  "personalCode": 38006309999,
+} satisfies LithuaniaIdCardProviderOutput
+
+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 LithuaniaIdCardProviderOutput
+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/LloydsSmartIdProviderOutput.md

@@ -0,0 +1,57 @@
+
+# LloydsSmartIdProviderOutput
+
+Exposed properties for the `lloyds-smart-id` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`rememberMeId` | string
+`email` | string
+`givenName` | string
+`familyName` | string
+`fullName` | string
+`dateOfBirth` | Date
+`gender` | string
+`nationality` | string
+`mobileNumber` | string
+`structuredPostalAddress` | [YotiStructuredPostalAddress](YotiStructuredPostalAddress.md)
+`postalAddress` | string
+`documentDetails` | [YotiDocumentDetails](YotiDocumentDetails.md)
+
+## Example
+
+```typescript
+import type { LloydsSmartIdProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "rememberMeId": 9f63ff98-e1e3-433c-9b86-7c697d0b4e5f,
+  "email": johndoe@example.com,
+  "givenName": John Alvin,
+  "familyName": Doe,
+  "fullName": John Alvin Doe,
+  "dateOfBirth": Thu Jan 31 00:00:00 UTC 1985,
+  "gender": MALE,
+  "nationality": GBR,
+  "mobileNumber": +447777123456,
+  "structuredPostalAddress": null,
+  "postalAddress": 6th Floor, 107 Leadenhall St, London, EC3A 4AF,
+  "documentDetails": null,
+} satisfies LloydsSmartIdProviderOutput
+
+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 LloydsSmartIdProviderOutput
+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/Match.md

@@ -0,0 +1,36 @@
+
+# Match
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`probabilityValue` | number
+`booleanValue` | boolean
+
+## Example
+
+```typescript
+import type { Match } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "probabilityValue": null,
+  "booleanValue": null,
+} satisfies Match
+
+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 Match
+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)
+
+