@trinsic/api 3.0.1 → 3.1.0-preview1

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

package/docs/MatchData.md

@@ -0,0 +1,55 @@
+
+# MatchData
+
+Match results for the data being matched against.              This applies to Providers which operate based on matching data / biometrics against a government database, returning match scores or results as opposed to the data itself.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`nationalIdNumber` | [Match](Match.md)
+`fullName` | [Match](Match.md)
+`givenName` | [Match](Match.md)
+`middleName` | [Match](Match.md)
+`familyName` | [Match](Match.md)
+`sex` | [Match](Match.md)
+`dateOfBirth` | [Match](Match.md)
+`phoneNumber` | [Match](Match.md)
+`faceMatch` | [Match](Match.md)
+`liveness` | [Match](Match.md)
+`imageAuthenticity` | [Match](Match.md)
+
+## Example
+
+```typescript
+import type { MatchData } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "nationalIdNumber": null,
+  "fullName": null,
+  "givenName": null,
+  "middleName": null,
+  "familyName": null,
+  "sex": null,
+  "dateOfBirth": null,
+  "phoneNumber": null,
+  "faceMatch": null,
+  "liveness": null,
+  "imageAuthenticity": null,
+} satisfies MatchData
+
+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 MatchData
+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/MdlExchangeMechanism.md

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

@@ -0,0 +1,40 @@
+
+# MdlOutput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`iacaRootCertificate` | [MdlOutputCertificateData](MdlOutputCertificateData.md)
+`documentSignerCertificate` | [MdlOutputCertificateData](MdlOutputCertificateData.md)
+`documentType` | string
+`nameSpaces` | { [key: string]: { [key: string]: MdlOutputFieldData; }; }
+
+## Example
+
+```typescript
+import type { MdlOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "iacaRootCertificate": null,
+  "documentSignerCertificate": null,
+  "documentType": org.iso.18013.5.1.mDL,
+  "nameSpaces": {"org.iso.18013.5.1":{"family_name":{"type":"String","value":"DOE"},"given_name":{"type":"String","value":"JOHN"},"birth_date":{"type":"String","value":"2000-03-27"},"age_over_21":{"type":"Boolean","value":"true"}}},
+} satisfies MdlOutput
+
+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 MdlOutput
+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/MdlOutputCertificateData.md

@@ -0,0 +1,42 @@
+
+# MdlOutputCertificateData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`serialNumber` | string
+`commonName` | string
+`stateOrProvinceName` | string
+`notBefore` | Date
+`notAfter` | Date
+
+## Example
+
+```typescript
+import type { MdlOutputCertificateData } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "serialNumber": 535868140170056787981774412188464491855209169584,
+  "commonName": California DMV IACA Root,
+  "stateOrProvinceName": US-CA,
+  "notBefore": 2023-03-01T17:17:39Z,
+  "notAfter": 2033-01-07T17:17:39Z,
+} satisfies MdlOutputCertificateData
+
+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 MdlOutputCertificateData
+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/MdlOutputFieldData.md

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

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

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

@@ -0,0 +1,35 @@
+
+# MexicoCurpProviderOutput
+
+Exposed properties for the `mexico-curp-lookup` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`curpStatus` | string
+
+## Example
+
+```typescript
+import type { MexicoCurpProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "curpStatus": AN,
+} satisfies MexicoCurpProviderOutput
+
+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 MexicoCurpProviderOutput
+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/MitIdProviderOutput.md

@@ -0,0 +1,55 @@
+
+# MitIdProviderOutput
+
+Exposed properties for the `denmark-mitid` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`dateOfBirth` | Date
+`uniqueIdentifier` | string
+`authenticationAssuranceLevel` | string
+`identityAuthenticationLevel` | string
+`levelOfAssurance` | string
+`identificationSource` | string
+`civilRegistrationNumber` | string
+`organizationName` | string
+`organizationNumber` | string
+`authorizedRepresentativeNumber` | string
+
+## Example
+
+```typescript
+import type { MitIdProviderOutput } 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,
+  "uniqueIdentifier": 8ba191ec-64b1-41c1-b622-4b8c14c34428,
+  "authenticationAssuranceLevel": https://data.gov.dk/concept/core/nsis/Substantial,
+  "identityAuthenticationLevel": https://data.gov.dk/concept/core/nsis/Substantial,
+  "levelOfAssurance": https://data.gov.dk/concept/core/nsis/Substantial,
+  "identificationSource": private,
+  "civilRegistrationNumber": 01311985-1234,
+  "organizationName": Dansk Standard,
+  "organizationNumber": DK12345678,
+  "authorizedRepresentativeNumber": 8ba191ec-64b1-41c1-b622-4b8c14c34428,
+} satisfies MitIdProviderOutput
+
+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 MitIdProviderOutput
+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)
+
+