@trinsic/api 3.0.1 → 3.1.0-preview1

package/docs/ContractAttachment.md

@@ -0,0 +1,37 @@
+
+# ContractAttachment
+
+Information about an attachment that a Provider may return in verification results.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`outputted` | [AttributeAvailability](AttributeAvailability.md)
+
+## Example
+
+```typescript
+import type { ContractAttachment } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": document_portrait,
+  "outputted": null,
+} satisfies ContractAttachment
+
+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 ContractAttachment
+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/ContractAttribute.md

@@ -0,0 +1,37 @@
+
+# ContractAttribute
+
+Information about an attribute that a Provider may return in verification results.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`scope` | string
+`outputted` | [AttributeAvailability](AttributeAvailability.md)
+
+## Example
+
+```typescript
+import type { ContractAttribute } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "scope": person.givenName,
+  "outputted": null,
+} satisfies ContractAttribute
+
+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 ContractAttribute
+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/CoteDIvoireNidLookup2Input.md

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

@@ -0,0 +1,51 @@
+
+# CoteDIvoireNidLookup2ProviderOutput
+
+Exposed properties for the `cote-divoire-nid-lookup-2` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`givenName` | string
+`familyName` | string
+`dateOfBirth` | Date
+`sex` | string
+`nationality` | string
+`address` | string
+`documentNumber` | string
+`nationalIdNumber` | string
+
+## Example
+
+```typescript
+import type { CoteDIvoireNidLookup2ProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullName": Jean Dupont,
+  "givenName": Jean,
+  "familyName": Dupont,
+  "dateOfBirth": Sat Jan 01 00:00:00 UTC 2000,
+  "sex": Male,
+  "nationality": CI,
+  "address": PLATEAU,ABIDJAN,
+  "documentNumber": I001111111,
+  "nationalIdNumber": 12345678901,
+} satisfies CoteDIvoireNidLookup2ProviderOutput
+
+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 CoteDIvoireNidLookup2ProviderOutput
+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/CreateDirectProviderSessionRequest.md

@@ -0,0 +1,46 @@
+
+# CreateDirectProviderSessionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`provider` | string
+`verificationProfileId` | string
+`redirectUrl` | string
+`capabilities` | [Array<IntegrationCapability>](IntegrationCapability.md)
+`fallbackToHostedUI` | boolean
+`browserLanguages` | Array<string>
+`providerInput` | [ProviderInput](ProviderInput.md)
+
+## Example
+
+```typescript
+import type { CreateDirectProviderSessionRequest } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "provider": null,
+  "verificationProfileId": null,
+  "redirectUrl": null,
+  "capabilities": null,
+  "fallbackToHostedUI": null,
+  "browserLanguages": null,
+  "providerInput": null,
+} satisfies CreateDirectProviderSessionRequest
+
+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 CreateDirectProviderSessionRequest
+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/CreateDirectProviderSessionResponse.md

@@ -0,0 +1,38 @@
+
+# CreateDirectProviderSessionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sessionId` | string
+`resultCollection` | [ResultCollection](ResultCollection.md)
+`nextStep` | [IntegrationStep](IntegrationStep.md)
+
+## Example
+
+```typescript
+import type { CreateDirectProviderSessionResponse } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sessionId": 00000000-0000-0000-0000-000000000000,
+  "resultCollection": null,
+  "nextStep": null,
+} satisfies CreateDirectProviderSessionResponse
+
+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 CreateDirectProviderSessionResponse
+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/CreateHostedProviderSessionRequest.md

@@ -0,0 +1,42 @@
+
+# CreateHostedProviderSessionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`provider` | string
+`verificationProfileId` | string
+`redirectUrl` | string
+`browserLanguages` | Array<string>
+`providerInput` | [ProviderInput](ProviderInput.md)
+
+## Example
+
+```typescript
+import type { CreateHostedProviderSessionRequest } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "provider": null,
+  "verificationProfileId": null,
+  "redirectUrl": null,
+  "browserLanguages": null,
+  "providerInput": null,
+} satisfies CreateHostedProviderSessionRequest
+
+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 CreateHostedProviderSessionRequest
+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/CreateHostedProviderSessionResponse.md

@@ -0,0 +1,38 @@
+
+# CreateHostedProviderSessionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sessionId` | string
+`launchUrl` | string
+`resultsAccessKey` | string
+
+## Example
+
+```typescript
+import type { CreateHostedProviderSessionResponse } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sessionId": null,
+  "launchUrl": https://verify.trinsic.id/api/session/launch?clientToken=...,
+  "resultsAccessKey": 417zNGHMJp6Ht2jCoktTLNGDRZEt4BqTwwQ8Q9ZaQz8aS4Jd7nD1xff2WLhPS69j5q9QT4gvgV79Gv7QtaXwu5YC9Utr35...,
+} satisfies CreateHostedProviderSessionResponse
+
+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 CreateHostedProviderSessionResponse
+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/CreateVerificationProfileResponse.md

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

@@ -0,0 +1,44 @@
+
+# CzechMojeIdAddressOutput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`streetAddress` | string
+`city` | string
+`region` | string
+`postalCode` | string
+`country` | string
+`formattedAddress` | string
+
+## Example
+
+```typescript
+import type { CzechMojeIdAddressOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "streetAddress": HAVELSKÁ 65,
+  "city": BRNO,
+  "region": Jihomoravský kraj,
+  "postalCode": 250 23,
+  "country": CZ,
+  "formattedAddress": HAVELSKÁ 65\n250 23 BRNO\nCZ,
+} satisfies CzechMojeIdAddressOutput
+
+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 CzechMojeIdAddressOutput
+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/CzechMojeIdProviderOutput.md

@@ -0,0 +1,83 @@
+
+# CzechMojeIdProviderOutput
+
+Exposed properties for the `czech-moje-id` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`subjectIdentifier` | string
+`name` | string
+`givenName` | string
+`familyName` | string
+`nickname` | string
+`email` | string
+`emailVerified` | boolean
+`phoneNumber` | string
+`phoneNumberVerified` | boolean
+`dateOfBirth` | Date
+`gender` | string
+`idCardNumber` | string
+`passportNumber` | string
+`socialSecurityNumber` | string
+`isAdult` | boolean
+`accountValidated` | boolean
+`isdsId` | string
+`isStudent` | boolean
+`companyRegistrationNumber` | string
+`taxIdentificationNumber` | string
+`niaVerified` | boolean
+`transactionId` | string
+`homeAddress` | [CzechMojeIdAddressOutput](CzechMojeIdAddressOutput.md)
+`billingAddress` | [CzechMojeIdAddressOutput](CzechMojeIdAddressOutput.md)
+`shippingAddress` | [CzechMojeIdAddressOutput](CzechMojeIdAddressOutput.md)
+
+## Example
+
+```typescript
+import type { CzechMojeIdProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "subjectIdentifier": abc123def456,
+  "name": Jan Novak,
+  "givenName": Jan,
+  "familyName": Novak,
+  "nickname": Honza,
+  "email": jan.novak@example.com,
+  "emailVerified": true,
+  "phoneNumber": +420123456789,
+  "phoneNumberVerified": true,
+  "dateOfBirth": Mon Jan 15 00:00:00 UTC 1990,
+  "gender": male,
+  "idCardNumber": 123456789,
+  "passportNumber": 49206778,
+  "socialSecurityNumber": 7801011234,
+  "isAdult": true,
+  "accountValidated": true,
+  "isdsId": avxipbf,
+  "isStudent": false,
+  "companyRegistrationNumber": 12345678,
+  "taxIdentificationNumber": CZ12345678,
+  "niaVerified": true,
+  "transactionId": af82asdfjacv945a98afasf,
+  "homeAddress": null,
+  "billingAddress": null,
+  "shippingAddress": null,
+} satisfies CzechMojeIdProviderOutput
+
+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 CzechMojeIdProviderOutput
+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/CzechiaMojeIdProviderOutput.md

@@ -0,0 +1,41 @@
+
+# CzechiaMojeIdProviderOutput
+
+Exposed properties for the `a-mojeid` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`dateOfBirth` | Date
+`openId2Identifier` | string
+
+## Example
+
+```typescript
+import type { CzechiaMojeIdProviderOutput } 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,
+  "openId2Identifier": https://tpalts3.mojeid.regtest.nic.cz/#jjczaJE2Hfsg,
+} satisfies CzechiaMojeIdProviderOutput
+
+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 CzechiaMojeIdProviderOutput
+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/DigilockerAadhaarProviderOutput.md

@@ -0,0 +1,47 @@
+
+# DigilockerAadhaarProviderOutput
+
+Exposed properties for the `india-digilocker-aadhaar` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentType` | string
+`timestamp` | Date
+`timeToLive` | Date
+`aadhaarNumberLastFour` | string
+`claims` | [AadhaarClaims](AadhaarClaims.md)
+`localizedClaims` | [AadhaarLocalizedClaims](AadhaarLocalizedClaims.md)
+`documentSignatureValidated` | boolean
+
+## Example
+
+```typescript
+import type { DigilockerAadhaarProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentType": ADHAR,
+  "timestamp": 2025-06-01T20:43:54.472+05:30,
+  "timeToLive": null,
+  "aadhaarNumberLastFour": 1234,
+  "claims": null,
+  "localizedClaims": null,
+  "documentSignatureValidated": true,
+} satisfies DigilockerAadhaarProviderOutput
+
+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 DigilockerAadhaarProviderOutput
+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/DocumentData.md

@@ -0,0 +1,46 @@
+
+# DocumentData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | [DocumentType](DocumentType.md)
+`number` | string
+`issueDate` | Date
+`expirationDate` | Date
+`issuingCountry` | string
+`issuingSubdivision` | string
+`issuingAuthority` | string
+
+## Example
+
+```typescript
+import type { DocumentData } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "number": D1234567,
+  "issueDate": Wed Jan 15 00:00:00 UTC 2025,
+  "expirationDate": Tue Jan 15 00:00:00 UTC 2030,
+  "issuingCountry": US,
+  "issuingSubdivision": US-NY,
+  "issuingAuthority": null,
+} satisfies DocumentData
+
+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 DocumentData
+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/DocumentType.md

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