@trinsic/api 3.0.2-preview1 → 3.1.0-preview1

package/docs/GuatemalaCuiProviderOutput.md

@@ -0,0 +1,53 @@
+
+# GuatemalaCuiProviderOutput
+
+Exposed properties for the `guatemala-cui-lookup` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`givenName` | string
+`familyName` | string
+`dateOfBirth` | Date
+`documentNumber` | string
+`serialDigits` | string
+`verifierDigit` | string
+`geographicDigits` | string
+`sex` | string
+`arrayName` | Array<string>
+
+## Example
+
+```typescript
+import type { GuatemalaCuiProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullName": JUAN CARLOS PEREZ GARCIA,
+  "givenName": JUAN CARLOS,
+  "familyName": PEREZ GARCIA,
+  "dateOfBirth": Wed Jan 13 00:00:00 UTC 1999,
+  "documentNumber": 1234567890101,
+  "serialDigits": 12345678,
+  "verifierDigit": 9,
+  "geographicDigits": 0101,
+  "sex": Male,
+  "arrayName": ["JUAN","CARLOS","PEREZ","GARCIA"],
+} satisfies GuatemalaCuiProviderOutput
+
+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 GuatemalaCuiProviderOutput
+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/IdentityData.md

@@ -0,0 +1,46 @@
+
+# IdentityData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`originatingProviderId` | string
+`originatingSubProviderId` | string
+`person` | [PersonData](PersonData.md)
+`document` | [DocumentData](DocumentData.md)
+`match` | [MatchData](MatchData.md)
+`attachments` | [Array<AttachmentInfo>](AttachmentInfo.md)
+`providerOutput` | [ProviderOutput](ProviderOutput.md)
+
+## Example
+
+```typescript
+import type { IdentityData } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "originatingProviderId": null,
+  "originatingSubProviderId": null,
+  "person": null,
+  "document": null,
+  "match": null,
+  "attachments": null,
+  "providerOutput": null,
+} satisfies IdentityData
+
+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 IdentityData
+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/IdinInput.md

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

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

@@ -0,0 +1,49 @@
+
+# IndiaPanLookupProviderOutput
+
+Exposed properties for the `india-pan-lookup` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`permanentAccountNumber` | string
+`structuredPermanentAccountNumber` | [IndiaPanStructuredNumber](IndiaPanStructuredNumber.md)
+`fullName` | string
+`givenName` | string
+`middleName` | string
+`familyName` | string
+`dateOfBirth` | string
+`panStatus` | string
+
+## Example
+
+```typescript
+import type { IndiaPanLookupProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "permanentAccountNumber": ABCPS1234Z,
+  "structuredPermanentAccountNumber": null,
+  "fullName": Rajesh Kumar Sharma,
+  "givenName": Rajesh,
+  "middleName": Kumar,
+  "familyName": Sharma,
+  "dateOfBirth": 1943-08-15,
+  "panStatus": VALID,
+} satisfies IndiaPanLookupProviderOutput
+
+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 IndiaPanLookupProviderOutput
+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/IndiaPanStructuredNumber.md

@@ -0,0 +1,44 @@
+
+# IndiaPanStructuredNumber
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`seriesCode` | string
+`assesseeCategoryCode` | string
+`assesseeCategoryName` | string
+`namePrefixLetter` | string
+`serialNumber` | string
+`checkLetter` | string
+
+## Example
+
+```typescript
+import type { IndiaPanStructuredNumber } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "seriesCode": ABC,
+  "assesseeCategoryCode": P,
+  "assesseeCategoryName": Individual,
+  "namePrefixLetter": S,
+  "serialNumber": 1234,
+  "checkLetter": Z,
+} satisfies IndiaPanStructuredNumber
+
+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 IndiaPanStructuredNumber
+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/IndonesiaDukcapilMatchInput.md

@@ -0,0 +1,48 @@
+
+# IndonesiaDukcapilMatchInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`dateOfBirth` | Date
+`nikIdNumber` | string
+`email` | string
+`phoneNumber` | string
+`selfieImage` | string
+`documentImage` | string
+`consentGivenAt` | Date
+
+## Example
+
+```typescript
+import type { IndonesiaDukcapilMatchInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullName": null,
+  "dateOfBirth": null,
+  "nikIdNumber": null,
+  "email": null,
+  "phoneNumber": null,
+  "selfieImage": null,
+  "documentImage": null,
+  "consentGivenAt": null,
+} satisfies IndonesiaDukcapilMatchInput
+
+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 IndonesiaDukcapilMatchInput
+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/IndonesiaNikInput.md

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

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

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

@@ -0,0 +1,39 @@
+
+# IntegrationStep
+
+A step to perform in the process of executing a Direct Provider Session
+
+## Properties
+
+Name | Type
+------------ | -------------
+`method` | [IntegrationLaunchMethod](IntegrationLaunchMethod.md)
+`content` | string
+`refresh` | [StepRefreshInfo](StepRefreshInfo.md)
+
+## Example
+
+```typescript
+import type { IntegrationStep } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "method": null,
+  "content": https://verify.trinsic.id/api/session/launch?clientToken=...,
+  "refresh": null,
+} satisfies IntegrationStep
+
+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 IntegrationStep
+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/ItsmeProviderOutput.md

@@ -0,0 +1,43 @@
+
+# ItsmeProviderOutput
+
+Exposed properties for the `a-itsme-login` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`dateOfBirth` | Date
+`hashedNationalRegisterNumber` | string
+`nationalRegisterNumber` | string
+
+## Example
+
+```typescript
+import type { ItsmeProviderOutput } 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,
+  "hashedNationalRegisterNumber": 5d17e158243dff0bd79fbfd06b27b80d04a40a6a0425e1bbb474c7634a2918f7,
+  "nationalRegisterNumber": 83122412413,
+} satisfies ItsmeProviderOutput
+
+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 ItsmeProviderOutput
+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/KenyaNidBiometric2Input.md

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

@@ -0,0 +1,44 @@
+
+# KenyaNidInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`middleName` | string
+`lastName` | string
+`dateOfBirth` | Date
+`gender` | string
+`nationalIdNumber` | string
+
+## Example
+
+```typescript
+import type { KenyaNidInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": null,
+  "middleName": null,
+  "lastName": null,
+  "dateOfBirth": null,
+  "gender": null,
+  "nationalIdNumber": null,
+} satisfies KenyaNidInput
+
+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 KenyaNidInput
+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/KenyaNidLookup2Address.md

@@ -0,0 +1,43 @@
+
+# KenyaNidLookup2Address
+
+Represents a Kenya address as stored in the IPRS (Integrated Population Registration System) database.              The structure reflects the pre-2010 provincial administration system: District > Division > Location. Since the 2010 constitutional change to counties, these legacy administrative divisions are still maintained in IPRS records for historical continuity.              The raw address from IPRS is a newline-separated string with labeled administrative components. Example format:              ``` P O BOX 41842 NAIROBI PARLIAMENT BUILDINGS LOCATION - CITY SQUARE DIVISION - CENTRAL DISTRICT - NAIROBI ```              The first lines contain informal address details (village, P.O. Box) while the suffixed lines contain official administrative designations prefixed with labels like \"LOCATION -\", \"DIVISION -\", \"DISTRICT -\".
+
+## Properties
+
+Name | Type
+------------ | -------------
+`district` | string
+`division` | string
+`location` | string
+`additionalLines` | Array<string>
+`raw` | string
+
+## Example
+
+```typescript
+import type { KenyaNidLookup2Address } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "district": NAIROBI,
+  "division": CENTRAL,
+  "location": CITY SQUARE,
+  "additionalLines": ["P O BOX 41842 NAIROBI","PARLIAMENT BUILDINGS"],
+  "raw": P O BOX 41842 NAIROBI\nPARLIAMENT BUILDINGS\nLOCATION - CITY SQUARE\nDIVISION - CENTRAL\nDISTRICT - NAIROBI,
+} satisfies KenyaNidLookup2Address
+
+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 KenyaNidLookup2Address
+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/KenyaNidLookup2Input.md

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