@trinsic/api 3.0.2-preview1 → 3.1.0-preview1

package/docs/NigeriaNinInput.md

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

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

@@ -0,0 +1,57 @@
+
+# NigeriaNinLookup2ProviderOutput
+
+Exposed properties for the `nigeria-nin-lookup-2` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`middleName` | string
+`surname` | string
+`sex` | string
+`dateOfBirth` | Date
+`birthCountry` | string
+`nationalIdentityNumber` | string
+`phoneNumber` | string
+`email` | string
+`address` | string
+`localGovernmentArea` | string
+`state` | string
+
+## Example
+
+```typescript
+import type { NigeriaNinLookup2ProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": MUSA,
+  "middleName": IBRAHIM,
+  "surname": MOHAMMED,
+  "sex": Male,
+  "dateOfBirth": Wed Jan 31 00:00:00 UTC 1990,
+  "birthCountry": NG,
+  "nationalIdentityNumber": 12345678901,
+  "phoneNumber": +2340123456789,
+  "email": user@example.com,
+  "address": 816 ahmadu bello way central business district abuja,
+  "localGovernmentArea": Abuja Municipal,
+  "state": Federal Capital Territory,
+} satisfies NigeriaNinLookup2ProviderOutput
+
+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 NigeriaNinLookup2ProviderOutput
+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/NigeriaNinMatch2Input.md

@@ -0,0 +1,46 @@
+
+# NigeriaNinMatch2Input
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`idNumber` | string
+`givenName` | string
+`familyName` | string
+`middleName` | string
+`dateOfBirth` | Date
+`sex` | [NigeriaNinMatch2InputSex](NigeriaNinMatch2InputSex.md)
+`phoneNumber` | string
+
+## Example
+
+```typescript
+import type { NigeriaNinMatch2Input } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "idNumber": null,
+  "givenName": null,
+  "familyName": null,
+  "middleName": null,
+  "dateOfBirth": null,
+  "sex": null,
+  "phoneNumber": null,
+} satisfies NigeriaNinMatch2Input
+
+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 NigeriaNinMatch2Input
+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/NigeriaNinMatch2InputSex.md

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

@@ -0,0 +1,49 @@
+
+# NorwegianBankIdProviderOutput
+
+Exposed properties for the `norway-bankid` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`dateOfBirth` | Date
+`personalIdentifier` | string
+`nationalIdentityNumber` | string
+`givenName` | string
+`familyName` | string
+`levelOfAssurance` | string
+`authenticationMethod` | string
+
+## Example
+
+```typescript
+import type { NorwegianBankIdProviderOutput } 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,
+  "personalIdentifier": 9578-5999-4-1765512,
+  "nationalIdentityNumber": 30069012345,
+  "givenName": Ole,
+  "familyName": Olsen,
+  "levelOfAssurance": High,
+  "authenticationMethod": urn:bankid:bis,
+} satisfies NorwegianBankIdProviderOutput
+
+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 NorwegianBankIdProviderOutput
+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/OneIdProviderAddress.md

@@ -0,0 +1,42 @@
+
+# OneIdProviderAddress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`streetAddress` | string
+`locality` | string
+`region` | string
+`postalCode` | string
+`countryCode` | string
+
+## Example
+
+```typescript
+import type { OneIdProviderAddress } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "streetAddress": 80 Temple Way, Winterton-On-Sea,
+  "locality": Great Yarmouth,
+  "region": Norfolk,
+  "postalCode": NR29 9QS,
+  "countryCode": GB,
+} satisfies OneIdProviderAddress
+
+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 OneIdProviderAddress
+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/OneIdProviderOutput.md

@@ -0,0 +1,45 @@
+
+# OneIdProviderOutput
+
+Exposed properties for the `oneid` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sub` | string
+`fullName` | string
+`givenName` | string
+`familyName` | string
+`birthdate` | Date
+`address` | [OneIdProviderAddress](OneIdProviderAddress.md)
+
+## Example
+
+```typescript
+import type { OneIdProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sub": 458924ee-f856-59ad-ae9f-6de2429a3c74,
+  "fullName": John Smith,
+  "givenName": John,
+  "familyName": Smith,
+  "birthdate": Thu Jan 31 00:00:00 UTC 1985,
+  "address": null,
+} satisfies OneIdProviderOutput
+
+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 OneIdProviderOutput
+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/OrderDirection.md

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

@@ -0,0 +1,40 @@
+
+# OutputFrejaAddress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`line1` | string
+`city` | string
+`postalCode` | string
+`country` | string
+
+## Example
+
+```typescript
+import type { OutputFrejaAddress } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "line1": 123 Residential St,
+  "city": New York,
+  "postalCode": 12345,
+  "country": SE,
+} satisfies OutputFrejaAddress
+
+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 OutputFrejaAddress
+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/OutputFrejaDocument.md

@@ -0,0 +1,40 @@
+
+# OutputFrejaDocument
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`serialNumber` | string
+`expirationDate` | Date
+`country` | string
+
+## Example
+
+```typescript
+import type { OutputFrejaDocument } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": PASS,
+  "serialNumber": SA1234567890,
+  "expirationDate": Sun Dec 31 00:00:00 UTC 2028,
+  "country": SE,
+} satisfies OutputFrejaDocument
+
+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 OutputFrejaDocument
+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/PanamaCedulaLookupInput.md

@@ -0,0 +1,36 @@
+
+# PanamaCedulaLookupInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentNumber` | string
+`dateOfBirth` | Date
+
+## Example
+
+```typescript
+import type { PanamaCedulaLookupInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentNumber": 8-1234-12345,
+  "dateOfBirth": Mon Mar 02 00:00:00 UTC 1992,
+} satisfies PanamaCedulaLookupInput
+
+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 PanamaCedulaLookupInput
+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/PanamaCedulaProviderOutput.md

@@ -0,0 +1,49 @@
+
+# PanamaCedulaProviderOutput
+
+Exposed properties for the `panama-cedula-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
+`nationalityOrResidenceType` | string
+`subdivisionOfOrigin` | string
+`subdivisionOfOriginName` | string
+
+## Example
+
+```typescript
+import type { PanamaCedulaProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullName": Juan Pérez,
+  "givenName": Juan,
+  "familyName": Pérez,
+  "dateOfBirth": Mon Mar 02 00:00:00 UTC 1992,
+  "documentNumber": 8-1234-12345,
+  "nationalityOrResidenceType": BornInPanama,
+  "subdivisionOfOrigin": PA-8,
+  "subdivisionOfOriginName": Panamá,
+} satisfies PanamaCedulaProviderOutput
+
+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 PanamaCedulaProviderOutput
+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/PersonData.md

@@ -0,0 +1,53 @@
+
+# PersonData
+
+Identity information for the individual being verified
+
+## Properties
+
+Name | Type
+------------ | -------------
+`givenName` | string
+`familyName` | string
+`middleName` | string
+`fullName` | string
+`suffix` | string
+`nationality` | string
+`sex` | [Sex](Sex.md)
+`phoneNumber` | string
+`address` | [Address](Address.md)
+`dateOfBirth` | Date
+
+## Example
+
+```typescript
+import type { PersonData } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "givenName": John,
+  "familyName": Doe,
+  "middleName": Jacob,
+  "fullName": John Jacob de Doe,
+  "suffix": null,
+  "nationality": null,
+  "sex": null,
+  "phoneNumber": null,
+  "address": null,
+  "dateOfBirth": null,
+} satisfies PersonData
+
+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 PersonData
+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/PeruDniAddress.md

@@ -0,0 +1,39 @@
+
+# PeruDniAddress
+
+Not a typical address. Does not include street or city. Instead, includes region, province and district.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`region` | string
+`province` | string
+`district` | string
+
+## Example
+
+```typescript
+import type { PeruDniAddress } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "region": CUSCO,
+  "province": URUBAMBA,
+  "district": MACHUPICCHU,
+} satisfies PeruDniAddress
+
+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 PeruDniAddress
+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/PeruDniLookupInput.md

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