TulipTulip Docs
Sinistres

Créer un sinistre (pré-déclaration)

Ce endpoint permet de créer une nouvelle pré-déclaration de sinistre en statut brouillon. Les questions obligatoires doivent être renseignées selon le type et sous-type du sinistre.

POST
/claims
key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://api.mytulip.io/v2/claims" \  -H "Content-Type: application/json" \  -d '{    "userId": "user_xyz789",    "contractId": "contract_abc123",    "contractProductId": "product_def456",    "type": "theft",    "subtype": "total_theft",    "claimAt": "2024-01-15T14:30:00Z",    "description": "Mon vélo a été volé le 15 janvier 2024 vers 14h30 devant la gare de Lyon. Il était attaché avec le cadenas fourni à un poteau.",    "questions": {      "property1": "string",      "property2": "string"    },    "insured": {      "firstName": "Jean",      "lastName": "Dupont",      "phoneNumber": "+33612345678"    },    "location": {      "address": "123 rue de Paris",      "city": "Paris",      "country": "France",      "zipcode": "75001"    }  }'
{
  "success": true,
  "data": {
    "id": "claim_xyz789",
    "claimId": "internal_claim_abc",
    "userId": "A1234567890",
    "status": "draft",
    "canSubmit": false,
    "type": "theft",
    "subtype": "total_theft",
    "claimAt": "2024-01-15T14:30:00Z",
    "declarationAt": "2024-01-16T10:00:00Z",
    "closedAt": "2025-01-01T00:00:00.000Z",
    "reopenedAt": "2025-01-01T00:00:00.000Z",
    "abandonedAt": "2025-01-01T00:00:00.000Z",
    "description": "Mon vélo a été volé le 15 janvier 2024 vers 14h30 devant la gare de Lyon.",
    "contractId": "contract_abc123",
    "contractProductId": "product_def456",
    "product": {
      "type": "bike",
      "subtype": "electric",
      "brand": "VanMoof",
      "model": "S3",
      "productMarked": "marked",
      "internalId": "bk-123456789",
      "custom": {
        "property1": null,
        "property2": null
      }
    },
    "location": {
      "address": "123 rue de Paris",
      "city": "Paris",
      "country": "France",
      "zipcode": "75001"
    },
    "insured": {
      "firstName": "Jean",
      "lastName": "Dupont",
      "phoneNumber": "+33612345678",
      "email": "jean.dupont@example.com",
      "company": "Acme Corp"
    },
    "questions": {
      "property1": "string",
      "property2": "string"
    },
    "documentEntries": [
      {
        "type": "Dépôt de plainte",
        "category": "mandatory",
        "status": "waiting_for",
        "document": {
          "id": "doc_abc123",
          "title": "Plainte du 15/01/2024",
          "mimeType": "application/pdf",
          "refusalReason": "string",
          "note": "string",
          "uploadedAt": "2024-01-16T10:30:00Z"
        }
      }
    ],
    "note": "string",
    "settlements": [
      {
        "id": "stl_abc123",
        "type": "refund",
        "amount": 150,
        "paymentAt": "2024-02-15T14:30:00Z",
        "createdAt": "2024-02-10T10:00:00Z"
      }
    ],
    "createdAt": "2024-01-16T10:00:00Z",
    "updatedAt": "2024-01-16T10:00:00Z"
  }
}
{
  "success": false,
  "error": {
    "code": 0,
    "message": "string"
  }
}
{
  "success": false,
  "error": {
    "code": 0,
    "message": "string"
  }
}

Que pensez-vous de cette page ?