@trinsic/api 3.0.1 → 3.1.0-preview1

package/docs/GetAttachmentRequest.md

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

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

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

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

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

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

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

@@ -0,0 +1,35 @@
+
+# GoogleWalletProviderOutput
+
+Exposed properties for the `google-wallet` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`rawMdlOutput` | [MdlOutput](MdlOutput.md)
+
+## Example
+
+```typescript
+import type { GoogleWalletProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "rawMdlOutput": null,
+} satisfies GoogleWalletProviderOutput
+
+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 GoogleWalletProviderOutput
+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/GuatemalaCuiLookupInput.md

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