The new endpoint for the Compatibility Check required for a VPP authentication or enrollment.

Connection URL's

Environment	URL

Environment	URL
Staging	https://centinelapistag.cardinalcommerce.com/V2/FIDO/Init
Production	https://centinelapi.cardinalcommerce.com/V2/FIDO/Init

Request

iss String required

An identifier of who is issuing the JWT. Used to contain the Api Key identifier or name.

jti String required

JWT ID, which is a unique identifier for this JWT. This field should change each time a JWT is generated.

iat Numeric required

The UNIX epoch time in seconds when the JWT was generated. This allows Cardinal to determine how long a JWT has existed and whether or not it is expired.

OrgUnitId String required

Processor/Merchant level OrgUnitId

ReturnUrl String required

The ReturnUrl is a claim used within the Cardinal Cruise API integration that allows for the integrator to know when the Device Data Collection and StepUpUrl interactions completed.

ObjectifyPayload Boolean required

A boolean flag that indicates how Cardinal should consume the Payload claim. When set to true, this tells us the Payload claim is an object. When set to false, the Payload claim is a stringified object.

Some Jwt libraries do not support passing objects as claims, this allows those who only allow strings to use their libraries without customization.

Payload Object required

The Payload for FIDO init contains the merchant origin required field by FIDO.

MerchantOrigin string required

The origin of the merchant.

For more information on origins go here: https://developer.mozilla.org/en-US/docs/Glossary/Origin

{
  "iss": "ApiKeyId",
  "jti": "6325c60f-d31c-4450-8184-30699ebac69c",
  "iat": 1448997865,
  "OrgUnitId": "MyOrgUnit",
  "ReturnUrl": "https://onlinestore.com/myreturn",
  "ObjectifyPayload": true,
  "Payload": {
     "MerchantOrigin": "https://onlinestore.com"
  }
}

Response

iss String required

An identifier of who is issuing the JWT. Used to contain the Api Key identifier or name.

iat String required

The UNIX epoch time in seconds of when the JWT was generated. This allows us to determine how long a JWT has been around and whether we consider it expired or not.

exp Numeric CONDITIONAL

The numeric epoch time that the JWT should be consider expired. This value is ignored if its larger than 2hrs. By default, we will consider any JWT older than 2hrs.

jti String required

A unique identifier for this JWT. This field should change each time a JWT is generated.

aud String required

Cardinal populates this field on response JWT to contain the request jti field. This allows merchant to match up request JWTs with response JWTs

Payload Object required

The Payload for FIDO init contains the merchant origin required field by FIDO.

ReferenceId String required

The ID returned from Cardinal during the FIDO Init request.

ErrorNumber String Conditional

An application error number. A non-zero value represents the error encountered while attempting to process the message request.

ErrorDescription String Conditional

Application error description for the associated error number

Some Possible Values include:

0 : Sucess
2000 : AccountNumber is not valid
1000 : An error has occured in the Service

{
  "iss": "5f0780aeadf32541e357357a",
  "iat": 1715173482,
  "exp": 1715180682,
  "jti": "6325c60f-d31c-4450-8184-30699ebac69c",
  "aud": "739debe0-799e-43fd-8bab-e254340cd745",
  "Payload": {
    "ReferenceId": "1234-12345-1234-1234",
    "ErrorNumber": 0,
    "ErrorDescription":"Success"
  }
}