Submit access credentials

POST

/v1/access-credentials

Submit access credentials to Calven.

Request

Body Params application/json

Example

{
    "data": [
        {
            "username": "user.email@example.com",
            "updateId": "379EB561-0378-4718-ACEA-5669932208A9",
            "credentials": [
                {
                    "active": true,
                    "cardNumber": "1234567890",
                    "facilityCode": "100",
                    "scanData": [
                        "100:1234567890"
                    ],
                    "credentialType": "Mifare"
                }
            ]
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.calven.com/v1/access-credentials' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": [
        {
            "username": "user.email@example.com",
            "updateId": "379EB561-0378-4718-ACEA-5669932208A9",
            "credentials": [
                {
                    "active": true,
                    "cardNumber": "1234567890",
                    "facilityCode": "100",
                    "scanData": [
                        "100:1234567890"
                    ],
                    "credentialType": "Mifare"
                }
            ]
        }
    ]
}'

Responses

🟢201Success

application/json

Body

Example

{
    "updateId": "379EB561-0378-4718-ACEA-5669932208A9",
    "result": "CARD_UPDATE_FAILED",
    "message": "User not found",
    "results": [
        {
            "cardNumber": "string",
            "facilityCode": "string",
            "result": "CARD_UPDATE_FAILED",
            "message": "string"
        }
    ]
}

Modified at 2025-04-03 13:59:13

Submit time off updates

Warehouse Overview