/identity/v2/sessions

Crear Sesión

El endpoint identity/v2/sessions permite crear una nueva sesión de validación de identidad para Personas Jurídicas, basada en alguno de nuestros flujos de validación, y te devuelve un identificador único de la misma.

Parámetros disponibles

Header Parameters
AuthorizationString
Cuerpo de solicitud
application/json
flow_typeenum
countryenum
integration_methodenum
dataobject3 propiedades

Detalle de respuestas

Ejemplo de solicitud
{
  "flow_type": "kyb-cards",
  "country": "BRA",
  "integration_method": "API",
  "data": {
    "company": {
      "id": "cmp-2HPUYx0n9USSNwSkP5G0gY1I2TO",
      "is_mei": true,
      "fiscal_id": "29.086.892/0001-77",
      "annual_income": 2000,
      "legal_nature": 2135
    },
    "partners": [
      {
        "id": "usr-2HPUYx0n9USSNwSkP5G0gY1I2TO",
        "partner_type": "legal-representative-main",
        "company_relationship": [
          "CompanyName"
        ],
        "corporate_participation": [
          "example_value"
        ],
        "fiscal_id": "123.456.789-10",
        "full_name": "Diego Pomelo",
        "birthdate": "1998-08-20",
        "nationality": "BRA",
        "mother_name": "Maria Pomelo",
        "phone": "+55 11 97487 2510",
        "pep": false,
        "salary": 48000,
        "address": {
          "street_name": "Av. Corrientes",
          "street_number": 300,
          "complement": "A",
          "zip_code": "12345-678",
          "neighborhood": "Villa Crespo"
        }
      }
    ],
    "terms_data": {
      "version": "1",
      "accept": true,
      "date": "2022-05-13T19:47:13.340Z"
    }
  }
}
Ejemplo de código
curl -X POST "https://api.pomelo.la/identity/v2/sessions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "flow_type": "kyb-cards",
  "country": "BRA",
  "integration_method": "API",
  "data": {
    "company": {
      "id": "cmp-2HPUYx0n9USSNwSkP5G0gY1I2TO",
      "is_mei": true,
      "fiscal_id": "29.086.892/0001-77",
      "annual_income": 2000,
      "legal_nature": 2135
    },
    "partners": [
      {
        "id": "usr-2HPUYx0n9USSNwSkP5G0gY1I2TO",
        "partner_type": "legal-representative-main",
        "company_relationship": [
          "CompanyName"
        ],
        "corporate_participation": [
          "example_value"
        ],
        "fiscal_id": "123.456.789-10",
        "full_name": "Diego Pomelo",
        "birthdate": "1998-08-20",
        "nationality": "BRA",
        "mother_name": "Maria Pomelo",
        "phone": "+55 11 97487 2510",
        "pep": false,
        "salary": 48000,
        "address": {
          "street_name": "Av. Corrientes",
          "street_number": 300,
          "complement": "A",
          "zip_code": "12345-678",
          "neighborhood": "Villa Crespo"
        }
      }
    ],
    "terms_data": {
      "version": "1",
      "accept": true,
      "date": "2022-05-13T19:47:13.340Z"
    }
  }
}'
Ejemplo de respuesta (201)Sesión creada
{
  "data": {}
}

Pomelo AI

Asistente de inteligencia artificial para consultas sobre la API de Pomelo
¡Hola!¿Cómo puedo ayudarte hoy?