Overview

The Virtual Cards API allows you to create and manage virtual cards for your customers. Before using any card functionality, customers must first complete KYC activation.

Base URL

Production base url : <https://api.yativo.com/api/v1>

Test base url : <https://smtp.yativo.com/api/v1>

Authentication & Headers

All non-GET requests require an Idempotency-Key header to ensure request uniqueness:

Idempotency-Key: unique-request-identifier
Content-Type: application/json

API Endpoints

1. Activate Customer for Virtual Cards

Before creating virtual cards, customers must complete KYC verification.

Endpoint: POST /customer/virtual/cards/activate

Request Body:

{
  "customer_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "customer_address": {
    "city": "New York",
    "state": "New York",
    "zipcode": "10001",
    "street": "123 Main Street Plaza",
    "country": "USA",
    "number": "25"
  },
  "customer_idFront": "<https://example.com/path/to/id-front.png>",
  "customer_idNumber": "A12345678",
  "date_of_birth": "01-01-1990",
  "user_photo": "<https://example.com/path/to/photo.png>"
}

Parameters:

• customer_id (string, required): Unique customer identifier
• customer_address (object, required): Customer's address information
  • city (string): City name
  • state (string): State/province
  • zipcode (string): Postal/ZIP code
  • street (string): Street address
  • country (string): Country name
  • number (string): House/building number
• customer_idFront (string, required): URL to front of ID document
• customer_idNumber (string, required): ID document number
• date_of_birth (string, required): Date of birth in DD-MM-YYYY format
• user_photo (string, required): URL to customer photo