@trinsic/api 3.0.1 → 3.1.0-preview1

package/docs/SpidBillingInformation.md

@@ -0,0 +1,39 @@
+
+# SpidBillingInformation
+
+Billing information for a SPID Verification.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`isBillable` | boolean
+`verificationType` | string
+`verificationLevel` | number
+
+## Example
+
+```typescript
+import type { SpidBillingInformation } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "isBillable": true,
+  "verificationType": "Authentication",
+  "verificationLevel": 1,
+} satisfies SpidBillingInformation
+
+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 SpidBillingInformation
+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/SpidInput.md

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

@@ -0,0 +1,81 @@
+
+# SpidProviderOutput
+
+Exposed properties for the `italy-spid` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`billingInformation` | [SpidBillingInformation](SpidBillingInformation.md)
+`identityProviderEntityId` | string
+`spidCode` | string
+`spidCredentialExpirationDate` | Date
+`rawIdCard` | string
+`givenName` | string
+`familyName` | string
+`dateOfBirth` | Date
+`gender` | string
+`placeOfBirth` | string
+`countyOfBirth` | string
+`domicileStreetAddress` | string
+`domicilePostalCode` | string
+`domicileMunicipality` | string
+`domicileProvince` | string
+`domicileNation` | string
+`email` | string
+`mobilePhone` | string
+`digitalAddress` | string
+`fiscalNumber` | string
+`ivaCode` | string
+`companyName` | string
+`companyFiscalNumber` | string
+`registeredOffice` | string
+
+## Example
+
+```typescript
+import type { SpidProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "billingInformation": null,
+  "identityProviderEntityId": https://spid.register.it,
+  "spidCode": SPID-002,
+  "spidCredentialExpirationDate": Sat Dec 21 00:00:00 UTC 2030,
+  "rawIdCard": passaporto KK1234567 questuraLivorno 2016-09-04 2026-09-03,
+  "givenName": Ada,
+  "familyName": Lovelace,
+  "dateOfBirth": Tue Dec 10 00:00:00 UTC 1985,
+  "gender": F,
+  "placeOfBirth": G702,
+  "countyOfBirth": PI,
+  "domicileStreetAddress": Via Liszt 21,
+  "domicilePostalCode": 00144,
+  "domicileMunicipality": Rome,
+  "domicileProvince": RM,
+  "domicileNation": IT,
+  "email": example@example.com,
+  "mobilePhone": 34912345678,
+  "digitalAddress": name@pecdomain.it,
+  "fiscalNumber": TINIT-ABCXYZ00W00Z000Z,
+  "ivaCode": VATIT-12345678901,
+  "companyName": ACME Corporation,
+  "companyFiscalNumber": TINIT-12345678901,
+  "registeredOffice": via Listz 21 00144 Rome,
+} satisfies SpidProviderOutput
+
+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 SpidProviderOutput
+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/StepRefreshInfo.md

@@ -0,0 +1,38 @@
+
+# StepRefreshInfo
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`expiresAt` | Date
+`refreshAfter` | Date
+`timeToLiveSeconds` | number
+
+## Example
+
+```typescript
+import type { StepRefreshInfo } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "expiresAt": null,
+  "refreshAfter": null,
+  "timeToLiveSeconds": null,
+} satisfies StepRefreshInfo
+
+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 StepRefreshInfo
+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/SubProviderMetadata.md

@@ -0,0 +1,41 @@
+
+# SubProviderMetadata
+
+Information about a sub-provider.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`subtext` | string
+`logoUrl` | string
+
+## Example
+
+```typescript
+import type { SubProviderMetadata } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "subtext": dmv.ca.gov,
+  "logoUrl": null,
+} satisfies SubProviderMetadata
+
+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 SubProviderMetadata
+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/SubmitNativeChallengeResponseRequest.md

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

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

@@ -0,0 +1,59 @@
+
+# SwedenBankIdProviderOutput
+
+Exposed properties for the `sweden-bankid` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`dateOfBirth` | Date
+`personalIdentityNumber` | string
+`givenName` | string
+`familyName` | string
+`country` | string
+`certificatePolicy` | string
+`commonName` | string
+`distinguishedName` | string
+`personalIdentityNumberIssuingCountry` | string
+`authenticationDeviceIp` | string
+`notBefore` | Date
+`notAfter` | Date
+
+## Example
+
+```typescript
+import type { SwedenBankIdProviderOutput } 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,
+  "personalIdentityNumber": 20200101-1231,
+  "givenName": Ove,
+  "familyName": Henriksen,
+  "country": SE,
+  "certificatePolicy": 1.2.752.78.1.1,
+  "commonName": Ove Henriksenn,
+  "distinguishedName": N=Ove Henriksen, OID.2.5.4.41=(180427 13.09) Ove Henriksen - BankID på fil, SERIALNUMBER=19531​​0021935, GIVENNAME=Ove, SURNAME=Henriksen, O=Testbank A AB (publ), C=SE ​,
+  "personalIdentityNumberIssuingCountry": SE,
+  "authenticationDeviceIp": 192.168.1.100,
+  "notBefore": 2024-01-01T00:00Z,
+  "notAfter": 2029-06-30T23:59:59Z,
+} satisfies SwedenBankIdProviderOutput
+
+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 SwedenBankIdProviderOutput
+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/TrinsicTestDatabaseLookupInput.md

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

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

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

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

@@ -0,0 +1,55 @@
+
+# UnitedKingdomEvisaProviderOutput
+
+Exposed properties for the `uk-evisa-lookup` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`dateOfBirth` | Date
+`shareCode` | string
+`referenceNumber` | string
+`expirationDate` | Date
+`validFrom` | Date
+`nationality` | string
+`immigrationStatus` | string
+`outcome` | string
+`evidenceType` | string
+
+## Example
+
+```typescript
+import type { UnitedKingdomEvisaProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": MUSA,
+  "lastName": MOHAMMED,
+  "dateOfBirth": Tue May 15 00:00:00 UTC 1990,
+  "shareCode": W86BC8RAH,
+  "referenceNumber": ABC1234567,
+  "expirationDate": Sun Dec 31 00:00:00 UTC 2028,
+  "validFrom": Mon Jan 15 00:00:00 UTC 2024,
+  "nationality": NG,
+  "immigrationStatus": Settled,
+  "outcome": pass,
+  "evidenceType": immigration_status,
+} satisfies UnitedKingdomEvisaProviderOutput
+
+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 UnitedKingdomEvisaProviderOutput
+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/UsaCaliforniaDmvInput.md

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

@@ -0,0 +1,50 @@
+
+# VerificationProfileResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`alias` | string
+`brandName` | string
+`externalId` | string
+`logoUrl` | string
+`primaryColor` | string
+`enabledProviders` | Array<string>
+`sessionExpiration` | string
+`isProductionUsage` | boolean
+
+## Example
+
+```typescript
+import type { VerificationProfileResponse } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "alias": null,
+  "brandName": null,
+  "externalId": null,
+  "logoUrl": null,
+  "primaryColor": null,
+  "enabledProviders": null,
+  "sessionExpiration": null,
+  "isProductionUsage": null,
+} satisfies VerificationProfileResponse
+
+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 VerificationProfileResponse
+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)
+
+