Stay organized with collections
Save and categorize content based on your preferences.
In this section, we explain how to establish connectivity and provide details
on the API design patterns and security model.
API communication details
Communication with the Virtual Cards API involves transport layer and
application layer security. The transport layer
uses TLS to secure HTTP requests (HTTPS) and the
application layer uses
either PGP or
JWE encryption.
In addition, our Protocol standards to find details on
our API design patterns and strategy for maintaining a robust connection with
partners.
Key exchanges
Encryption keys need to be rotated before they expire or if they are
compromised. As part of your implementation, you need to have a process for
managing these exchanges.
To ensure key rotations do not cause temporary outages or require significant
management overhead, Virtual Cards partners must support the use
of multiple encryption keys at once. During a key rotation, a second key will
be trusted and verified to be working correctly before the old key is removed.
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-03 UTC."],[[["\u003cp\u003eSecure communication with the Virtual Cards API is established through Transport Layer Security (TLS) for HTTP requests and application layer security using either PGP or JWE encryption.\u003c/p\u003e\n"],["\u003cp\u003ePartners can find details on API design patterns and connection strategies within the Protocol Standards section.\u003c/p\u003e\n"],["\u003cp\u003eEncryption key rotation is essential, and partners must support the use of multiple keys concurrently to avoid service disruptions during rotations.\u003c/p\u003e\n"],["\u003cp\u003eFailure to support multiple encryption keys will be considered a critical issue hindering the launch process.\u003c/p\u003e\n"]]],["The Virtual Cards API utilizes TLS for transport layer security (HTTPS) and either PGP or JWE for application layer security. Partners must adhere to API design patterns and maintain robust connections. Encryption keys require rotation before expiration or compromise, with partners mandated to support multiple encryption keys simultaneously to prevent outages. During key rotation, a new key is verified before removing the old one. Failure to support multiple keys will result in launch blockage.\n"],null,["# Overview\n\nIn this section, we explain how to establish connectivity and provide details\non the API design patterns and security model.\n\nAPI communication details\n-------------------------\n\nCommunication with the Virtual Cards API involves transport layer and\napplication layer security. The [transport layer](/pay/virtual-cards-v1/guides/connectivity/security/transport-layer)\nuses TLS to secure HTTP requests (HTTPS) and the\n[application layer](/pay/virtual-cards-v1/guides/connectivity/security/application-layer) uses\n\neither [PGP](/pay/virtual-cards-v1/guides/connectivity/security/application-layer#pgp_encryption) or\n[JWE](/pay/virtual-cards-v1/guides/connectivity/security/application-layer#jwe_encryption) encryption.\n\nIn addition, our [Protocol standards](/pay/virtual-cards-v1/guides/connectivity/protocol-standards) to find details on\nour API design patterns and strategy for maintaining a robust connection with\npartners.\n\nKey exchanges\n-------------\n\nEncryption keys need to be rotated before they expire or if they are\ncompromised. As part of your implementation, you need to have a process for\nmanaging these exchanges.\n\nTo ensure key rotations do not cause temporary outages or require significant\nmanagement overhead, Virtual Cards partners **must** support the use\nof multiple encryption keys at once. During a key rotation, a second key will\nbe trusted and verified to be working correctly before the old key is removed.\n| **Warning:** If support for multiple keys is not verified, it will be considered a launch blocking bug until it is resolved."]]