@trinsic/api 3.0.2-preview1 → 3.1.0-preview1

package/docs/ChinaResidentIdMatchInput.md

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

@@ -0,0 +1,39 @@
+
+# ChinaResidentIdMatchOutput
+
+Exposed properties for the `china-resident-id-match` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`dateOfBirth` | Date
+`residentIdNumber` | string
+
+## Example
+
+```typescript
+import type { ChinaResidentIdMatchOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullName": 陈明志,
+  "dateOfBirth": Thu Jan 31 00:00:00 UTC 1980,
+  "residentIdNumber": 110102198001318811,
+} satisfies ChinaResidentIdMatchOutput
+
+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 ChinaResidentIdMatchOutput
+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/ColombiaCcLookupInput.md

@@ -0,0 +1,36 @@
+
+# ColombiaCcLookupInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentNumber` | string
+`issueDate` | Date
+
+## Example
+
+```typescript
+import type { ColombiaCcLookupInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentNumber": 1234567890,
+  "issueDate": Fri Oct 31 00:00:00 UTC 2025,
+} satisfies ColombiaCcLookupInput
+
+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 ColombiaCcLookupInput
+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/ColombiaCcProviderOutput.md

@@ -0,0 +1,53 @@
+
+# ColombiaCcProviderOutput
+
+Exposed properties for the `colombia-cc-lookup` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`givenName` | string
+`familyName` | string
+`dateOfBirth` | Date
+`sex` | string
+`isAlive` | boolean
+`documentNumber` | string
+`expeditionDate` | Date
+`expeditionPlace` | [ColombiaExpeditionPlace](ColombiaExpeditionPlace.md)
+`arrayName` | Array<string>
+
+## Example
+
+```typescript
+import type { ColombiaCcProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullName": JUAN CARLOS PEREZ GOMEZ,
+  "givenName": JUAN CARLOS,
+  "familyName": PEREZ GOMEZ,
+  "dateOfBirth": Tue Jan 15 00:00:00 UTC 1985,
+  "sex": Male,
+  "isAlive": true,
+  "documentNumber": 1234567890,
+  "expeditionDate": Tue Mar 10 00:00:00 UTC 2020,
+  "expeditionPlace": null,
+  "arrayName": ["PEREZ","GOMEZ","JUAN","CARLOS"],
+} satisfies ColombiaCcProviderOutput
+
+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 ColombiaCcProviderOutput
+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/ColombiaExpeditionPlace.md

@@ -0,0 +1,37 @@
+
+# ColombiaExpeditionPlace
+
+Place of expedition (issue) for the Colombia Cédula de Ciudadanía (CC) as recorded by the Registraduría Nacional del Estado Civil (National Civil Registry).              Colombia uses a two-level administrative hierarchy for place of issue: municipality (municipio) within department (departamento).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`municipality` | string
+`department` | string
+
+## Example
+
+```typescript
+import type { ColombiaExpeditionPlace } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "municipality": BOGOTA D.C.,
+  "department": BOGOTA,
+} satisfies ColombiaExpeditionPlace
+
+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 ColombiaExpeditionPlace
+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/ConnectIdAddress.md

@@ -0,0 +1,42 @@
+
+# ConnectIdAddress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`streetAddress` | string
+`locality` | string
+`region` | string
+`country` | string
+`postalCode` | string
+
+## Example
+
+```typescript
+import type { ConnectIdAddress } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "streetAddress": L 7 SE 3 17 Jones St,
+  "locality": North Sydney,
+  "region": NSW,
+  "country": AUS,
+  "postalCode": 2060,
+} satisfies ConnectIdAddress
+
+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 ConnectIdAddress
+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/ConnectIdAgeVerification.md

@@ -0,0 +1,36 @@
+
+# ConnectIdAgeVerification
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`over18` | boolean
+`trustFramework` | string
+
+## Example
+
+```typescript
+import type { ConnectIdAgeVerification } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "over18": true,
+  "trustFramework": au_connectid,
+} satisfies ConnectIdAgeVerification
+
+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 ConnectIdAgeVerification
+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/ConnectIdProviderOutput.md

@@ -0,0 +1,53 @@
+
+# ConnectIdProviderOutput
+
+Exposed properties for the `australia-connect-id` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`birthdate` | Date
+`givenName` | string
+`middleName` | string
+`familyName` | string
+`phoneNumber` | string
+`email` | string
+`sub` | string
+`ageVerification` | [ConnectIdAgeVerification](ConnectIdAgeVerification.md)
+`transaction` | string
+`address` | [ConnectIdAddress](ConnectIdAddress.md)
+
+## Example
+
+```typescript
+import type { ConnectIdProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "birthdate": Thu Jan 31 00:00:00 UTC 1985,
+  "givenName": John,
+  "middleName": Albert,
+  "familyName": Smith,
+  "phoneNumber": +61271111222,
+  "email": johnasmith@example.com,
+  "sub": abcdefg123456,
+  "ageVerification": null,
+  "transaction": qaTTTTuhVnTck8zQlba4pFW2jo55555UfIoOEYv8sJq,
+  "address": null,
+} satisfies ConnectIdProviderOutput
+
+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 ConnectIdProviderOutput
+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/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)
+
+