> For the complete documentation index, see [llms.txt](https://docs.payments.thalescloud.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payments.thalescloud.io/merchant-tokenization/ja/bakkuendo/apis/client-api/models.md).

# Models

## The merchantId object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"merchantId":{"type":"string","description":"Identifier of the merchant provided by Thales at on-boarding.","minLength":1,"maxLength":128}}}}
```

## The tokenId object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"tokenId":{"type":"string","description":"The token identifier.","minLength":1,"maxLength":128}}}}
```

## The vProvisionedTokenId object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"vProvisionedTokenId":{"type":"string","description":"Specific to Visa. Another token identifier that shall be used only with Visa Cloud Token Framework.","minLength":1,"maxLength":36}}}}
```

## The deviceId object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"deviceId":{"type":"string","description":"The unique device identifier.","minLength":1,"maxLength":24}}}}
```

## The tokenLastDigits object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"tokenLastDigits":{"type":"string","maxLength":5,"description":"The token last digits."}}}}
```

## The tokenExpiryDate object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"tokenExpiryDate":{"type":"string","maxLength":4,"description":"The token expiry date in format MMYY. This information can be missing. It is intended for display only at this step.<br>Rely on token expiry date in create transaction response for storage."}}}}
```

## The cardBin object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"cardBin":{"type":"string","description":"The card bin returned by the scheme, just available for VISA and Mastercard SCOF.","minLength":6,"maxLength":8}}}}
```

## The cardLastDigits object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"cardLastDigits":{"type":"string","maxLength":5,"description":"The card last digits."}}}}
```

## The cardExpiryDate object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"cardExpiryDate":{"type":"string","maxLength":4,"description":"The card expiry date in format MMYY."}}}}
```

## The issuerName object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"issuerName":{"type":"string","maxLength":128,"description":"The card issuer name."}}}}
```

## The supportVisaCTF object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"supportVisaCTF":{"type":"boolean","description":"Indicate if Visa Cloud Token Framework is available."}}}}
```

## The cardDescription object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"cardDescription":{"type":"string","maxLength":256,"description":"The card description."}}}}
```

## The cardType object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"cardType":{"type":"string","description":"The card type.","maxLength":32,"enum":["CREDIT","DEBIT","PREPAID","UNKNOWN"]}}}}
```

## The scheme object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"scheme":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":["MASTERCARD","VISA","AMEX","DISCOVER","ELO"]}}}}
```

## The deviceBindings object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"deviceBindings":{"type":"array","description":"The list of device identifiers bound to the token as per Visa Cloud Token Framework.","items":{"$ref":"#/components/schemas/deviceId"},"uniqueItems":true},"deviceId":{"type":"string","description":"The unique device identifier.","minLength":1,"maxLength":24}}}}
```

## The termsAndConditionsUrl object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"termsAndConditionsUrl":{"type":"string","maxLength":512,"description":"Card issuer terms and conditions URL."}}}}
```

## The privacyPolicyUrl object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"privacyPolicyUrl":{"type":"string","maxLength":512,"description":"Card issuer privacy policy URL."}}}}
```

## The cardProduct object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"cardProduct":{"type":"object","description":"Information about the card product.","required":["cardType","scheme"],"properties":{"issuerName":{"$ref":"#/components/schemas/issuerName"},"cardType":{"$ref":"#/components/schemas/cardType"},"scheme":{"$ref":"#/components/schemas/scheme"},"supportVisaCTF":{"$ref":"#/components/schemas/supportVisaCTF"},"cardDescription":{"$ref":"#/components/schemas/cardDescription"},"cardArts":{"$ref":"#/components/schemas/cardArts"},"termsAndConditionsUrl":{"$ref":"#/components/schemas/termsAndConditionsUrl"},"privacyPolicyUrl":{"$ref":"#/components/schemas/privacyPolicyUrl"}}},"issuerName":{"type":"string","maxLength":128,"description":"The card issuer name."},"cardType":{"type":"string","description":"The card type.","maxLength":32,"enum":["CREDIT","DEBIT","PREPAID","UNKNOWN"]},"scheme":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":["MASTERCARD","VISA","AMEX","DISCOVER","ELO"]},"supportVisaCTF":{"type":"boolean","description":"Indicate if Visa Cloud Token Framework is available."},"cardDescription":{"type":"string","maxLength":256,"description":"The card description."},"cardArts":{"type":"object","properties":{"foregroundColor":{"type":"string","maxLength":6,"description":"Color used for the text displayed on the card (last digits, expiry date). Hexadecimal RGB color format."},"backgroundColor":{"type":"string","maxLength":6,"description":"Color used for card background. Hexadecimal RGB color format."},"cardBackgroundImageId":{"type":"string","maxLength":128,"description":"Asset identifier of the card background image. It doesn't contain the issuer/brand/co-brand logo."},"issuerLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the issuer logo."},"brandLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the primary brand logo."},"cobrandLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the cobrand logo."},"completeCardImageId":{"type":"string","maxLength":128,"description":"Asset identifier of the complete card image. Shall be preferred over the other assets when present."},"cardIconId":{"type":"string","maxLength":128,"description":"Asset identifier of the card icon."},"cardImageUrl":{"type":"string","maxLength":512,"description":"HTTP location of the card image. If present, no other identifier is provided and getAsset operation is not needed."}}},"termsAndConditionsUrl":{"type":"string","maxLength":512,"description":"Card issuer terms and conditions URL."},"privacyPolicyUrl":{"type":"string","maxLength":512,"description":"Card issuer privacy policy URL."}}}}
```

## The cardArts object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"cardArts":{"type":"object","properties":{"foregroundColor":{"type":"string","maxLength":6,"description":"Color used for the text displayed on the card (last digits, expiry date). Hexadecimal RGB color format."},"backgroundColor":{"type":"string","maxLength":6,"description":"Color used for card background. Hexadecimal RGB color format."},"cardBackgroundImageId":{"type":"string","maxLength":128,"description":"Asset identifier of the card background image. It doesn't contain the issuer/brand/co-brand logo."},"issuerLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the issuer logo."},"brandLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the primary brand logo."},"cobrandLogoId":{"type":"string","maxLength":128,"description":"Asset identifier of the cobrand logo."},"completeCardImageId":{"type":"string","maxLength":128,"description":"Asset identifier of the complete card image. Shall be preferred over the other assets when present."},"cardIconId":{"type":"string","maxLength":128,"description":"Asset identifier of the card icon."},"cardImageUrl":{"type":"string","maxLength":512,"description":"HTTP location of the card image. If present, no other identifier is provided and getAsset operation is not needed."}}}}}}
```

## The par object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"par":{"type":"string","maxLength":29,"description":"Payment Account Reference returned by the Scheme TSP."}}}}
```

## The tokenState object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"tokenState":{"type":"string","maxLength":64,"description":"Token state.</br>PCI token state can only be 'ACTIVE' or 'DELETED'.","enum":["ACTIVE","SUSPENDED","DELETED"]}}}}
```

## The discardCryptogram object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"discardCryptogram":{"type":"boolean","description":"If present and set to 'true', all pre-fetched cryptograms linked to the token shall be discarded as they are no more valid due to the token update.","default":false}}}}
```

## The creationTimestamp object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"creationTimestamp":{"type":"string","maxLength":64,"description":"Token or binding creation timestamp compliant with ISO 8601."}}}}
```

## The lastUpdateTimestamp object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"lastUpdateTimestamp":{"type":"string","maxLength":64,"description":"Token or binding last update timestamp compliant with ISO 8601."}}}}
```

## The lastUpdateTimestampMerchant object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"lastUpdateTimestampMerchant":{"type":"string","maxLength":64,"description":"Last update timestamp compliant with ISO 8601."}}}}
```

## The bindingState object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"bindingState":{"type":"string","maxLength":64,"description":"Binding state.","enum":["DELETED"]}}}}
```

## The deviceType object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"deviceType":{"type":"string","description":"The device type.","maxLength":32,"enum":["PHONE","TABLET","WATCH","TV","WEARABLE_DEVICE"]}}}}
```

## The appType object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"appType":{"type":"string","description":"The device type.","maxLength":32,"enum":["IOS","ANDROID","WEB"]}}}}
```

## The selectedIdvMethod object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"selectedIdvMethod":{"type":"string","description":"The ID&V method selected to bind the device.","maxLength":32,"enum":["OTP_SMS","OTP_EMAIL","OTP_ONLINE_BANKING","APP_TO_APP","OUTBOUND_CALL","CUSTOMER_SERVICE","NONE","UNKNOWN"]}}}}
```

## The eventInitiator object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"eventInitiator":{"type":"string","description":"The initiator of the event. For example a delete binding can be initiated by the scheme or by the app in the device.","maxLength":32,"enum":["TSP","APP"]}}}}
```

## The trId object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"trId":{"type":"string","description":"The Token Requestor Identifier generated by the scheme for that merchant.\nIn case of Mastercard Secure Card-On-File program, this field is not returned, see 'mcServiceId' instead.","minLength":1,"maxLength":32,"title":""}}}}
```

## The mcServiceId object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"mcServiceId":{"type":"string","description":"Token Requestor Id for SCOF solution, equivalent to the TRID. It is assigned by Mastercard to entity for which tokens are created. ","minLength":1,"maxLength":256}}}}
```

## The schemeOnboarding object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"schemeOnboarding":{"type":"string","description":"The card primary scheme.","maxLength":32,"enum":["MASTERCARD","VISA"]}}}}
```

## The error object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"error":{"type":"object","description":"Information about the error in case the token is not created.","properties":{"errorCode":{"type":"string","maxLength":128,"description":"The error code as specified in below table.\n\n-----------------\n|Error Code|Description|\n|-------|-------|\n|NON_RETRYABLE_ERROR|Generic code for all non retryable errors returned by the TMG.|\n|RETRYABLE_ERROR|Generic code for all retryable errors returned by the TMG.|\n|TSP_NON_RETRYABLE_ERROR|Generic code for all non retryable errors returned by the TSP.|\n|TSP_RETRYABLE_ERROR|Generic code for all retryable errors returned by the TSP.|\n|TSP_ABORTED|The TSP aborted the token creation process.|\n|INVALID_PAN_DATA|The PAN data is invalid.|\n|PAN_NOT_ELIGIBLE|The Issuer considers the PAN as not eligible for tokenization.|\n|ISSUER_DECLINED|The Issuer declined the tokenization.|\n|EXPIRED|The session timeout expired.|\n-----------------"},"errorDetails":{"type":"string","maxLength":256,"description":"Additional information about the error. This optional parameter has no specific format as it depends on the different TSP API. It is sent for logging and troubleshooting purpose."}},"required":["errorCode"]}}}}
```

## The errorOnboarding object

```json
{"openapi":"3.1.1","info":{"title":"Thales COF Client API","version":"1.42"},"components":{"schemas":{"errorOnboarding":{"type":"object","description":"Information about the error in case a problem occurs when a merchant is onboarded.","properties":{"errorCode":{"type":"string","maxLength":128,"description":"The error code as specified in below table.\n\n-----------------\n|Error Code|Description|\n|-------|-------|\n|NON_RETRYABLE_ERROR|Generic code for all non retryable errors returned by the TMG.|\n|RETRYABLE_ERROR|Generic code for all retryable errors returned by the TMG.|\n|TSP_NON_RETRYABLE_ERROR|Generic code for all non retryable errors returned by the TSP.|\n|TSP_RETRYABLE_ERROR|Generic code for all retryable errors returned by the TSP.|\n-----------------"},"errorDetails":{"type":"string","maxLength":256,"description":"Additional information about the error. This optional parameter has no specific format as it depends on the different TSP API. It is sent for logging and troubleshooting purpose."}},"required":["errorCode"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.payments.thalescloud.io/merchant-tokenization/ja/bakkuendo/apis/client-api/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.