Movilitas.Cloud Support

You can use the Verification DSCSA API to integrate the third-party systems with the Product Verification DSCSA application.

The Verification DSCSA API uses the Representational State Transfer (REST) standard to interact with other systems.

The Verification DSCSA API is an extension of the Product Verification DSCSA application of Movilitas.Cloud and enables you to send requests from external systems to the application.

This article describes how to send a verification request to Movilitas.Cloud by using the Verification DSCSA API.

API Tool to Use

In this document, we provide examples by using the cURL command-line tool. You can use any API tool to perform the API requests, for example, Postman or Katalon Studio.

Before You Begin

Before you start sending any messages:

1. You must enable the Product Verification DSCSA application in the Admin UI.

2. You must create an API key and secret. 

3. You must create a shopfloor channel with Verification DSCSA API source. You will need the channel key for your requests.

4. You must have the authentication token to send requests over API. Select one of the following ways:

• Apply a dynamic token. Send an authentication request over the Authentication API. For more information about the Authentication API, open the Tenant Dashboard in Movilitas.Cloud, select API keys, and choose Authentication API Documentation. Also, see Authentication Request.
• Apply a static token. Generate a static token for your previously created API key.

For more information, see Configuring the Movilitas.Cloud APIs.

Procedure

1. Use the POST method and the following URL:

https://api-staging.movilitas.cloud/v1/product_verification_dscsa/api/verify

2. For the header, define the following:

3. In the body of the request, define the parameters and their values based on the table below.

4. Send the request.

Sample cURL Request 

curl -X POST \
 'https://api-staging.movilitas.cloud/v1/product_verification_dscsa/api/verify' \
-H 'x-access-token: eyJhbGciOiJIUzI1NiIsInR6cDI6IkpXVCJ0.eyJrZXkiOiJmYjVtQUhyTmhta05mSkJjX250clRHRTNfZkoqRktlKkdqVDRFMkNNU0FtaEFGMk43Q2JmNEY3QVJTMy01M2Q4IiwiX2lkIjoiNjQyMzQxNTkyNmFiYzQ4ZDMxOTE0MWE0IiwiaWF0IjoxNjgwNDNyMTgzfQ.t894-oEC' \
-H 'x-channel-key: zBDgSJ1iKUpNmmcp1izN0QEBCaULGEGqxazXJ3H' \
-H 'Content-Type: application/json' \
-d '{
    "atp_verifiable_presentation": "eyJhbGciOiJFZERTSSIsInR6cCI6IkrXVCJ.0eyJpYXQiOjE2ODA3MDM1MTEsImV4cCI6MTY4MTQ4Njc2NiwidnAiRnsiQGMvbnRLeHQiOlsiaHR0cHM6My93d3cudzMub3JnLzIwMTgvY3JlZGVudGlhbHMvdjEiXSwidHlwZSI6Wy",
    "gln": "2996133448223",
    "serial": "MVCSN3048",
    "gtin": "00338300555778",
    "batch": "MVC001",
    "expiry_date": "250531",
    "verification_request_contact_info": {
        "email": "admin@movilitas.cloud",
        "telephone": "+3221234567"
    },
    "context": "dscsaSaleableReturn",
    "control_possess_attribute": true,
    "GS1US_version_value": "1.3.0"
}'

The application sends back a response that contains the following fields in the body:

For more information on verification failure reasons and additional information related to the pack, see VRS Responses for the Pack (Verification Failure Reason and Additional Info).

For more information on verification errors, see Verification Error Handling.

Sample Response (Success 200) 

{
    "success": true,
    "message": "Product verification response",
    "data": {
        "correlation_uuid": "6d8b0616-2b6d-48bc-8730-4fd17e7f1168",
        "verified": true,
        "verification_timestamp": "2023-04-12T16:37:07.275Z",
        "verification_failure_reason": "",
        "additional_info": "",
        "responder_gln": "0338300871687",
        "responder_atp_verifiable_presentation": "eyJhbGciOiJFAERTLSIsInR7cCI6IkpXWCJ.1eyJpYXQiOjE2ODEzMTc0MjcsImV4cCI6MTcxMjY1NTIwNiwidnAiOnsiRGM",
        "responder_atp": {},
        "responder_contact_email": "marc.blekkink@movilitas.com",
        "responder_contact_telephone": ""
    }
}