Skip to main content

Retours de l'API Omajva

Cette section détaille les retours fournis par l'API Omajva en fonction des documents traités. Chaque type de document retourne des informations spécifiques extraites lors du traitement.

1. KBIS​

Le KBIS est un extrait du registre du commerce et des sociétés. Lors du traitement, l'API renverra les informations suivantes :

Exemple de réponse​

[
    {
        "document_type": "kbis",
        "page_index": [
            0
        ],
        "read_success": true,
        "values": {
            "ape_code": "6202A",
            "company_name": "DUPOND SAS",
            "creation_date": "02/02/2012",
            "document_date": "24/09/2023",
            "siren": "187389865"
        }
    }
]

Champs extraits​

  • document_type : "kbis"
  • ape_code : Code APE
  • company_name : Nom de l'entreprise
  • creation_date : Date de création de l'entreprise
  • document_date :
  • siren : Numéro d'immatriculation (SIREN/SIRET)

2. Avis de situation SIRENE​

L'Avis de Situation SIRENE est un document officiel qui atteste de l'existence légale d'une entreprise et fournit des informations sur son inscription au répertoire SIRENE (Système Informatique pour le Répertoire des Entreprises et des Établissements). Il contient des informations comme le numéro SIRET, l'adresse et l'activité principale de l'entreprise. L'API renverra les informations suivantes :

Exemple de réponse​

[
    {
        "document_type": "ass",
        "page_index": [
            0
        ],
        "read_success": true,
        "values": {
            "ape_code": "6202A",
            "company_name": "DUPOND SAS",
            "creation_date": "12/05/2022",
            "document_date": "24/09/2023",
            "siren": "124387190"
        }
    }
]

Champs extraits​

  • document_type : "ass"
  • ape_code : Code APE
  • company_name : Nom de l'entreprise
  • creation_date : Date de création de l'entreprise
  • document_date : Date de création du document
  • siren : Numéro d'immatriculation (SIREN/SIRET)

3. Carte Grise​

La Carte Grise est un document officiel qui prouve l'autorisation de circuler d'un véhicule. Elle contient des informations clés sur le véhicule et son propriétaire, telles que le numéro d'immatriculation, le nom du titulaire, le modèle, et la date de première mise en circulation. L'API renverra les informations suivantes :

Exemple de réponse​

[
    {
        "document_type": "log_book",
        "page_index": [
            0
        ],
        "read_success": true,
        "values": {
            "formula": "21TN033836<",
            "issue_date": "19/11/2009",
            "last_name": "DUPONT",
            "license_plate": "AB-123-CD",
            "mrz_bottom": "CI<<MERCEDES<<<SR220TD<<<<<<98TN036623<38",
            "mrz_top": "CRFRAAB123CD0VF7X18E00018E847219801059VP<<<<",
            "prenoms": "EL",
            "registration_date": "05/01/1998",
            "second_name": "DUPOND",
            "vehicle_identification_number": "VF7X88E00008E8472",
            "vehicle_type": "X18E"
        }
    }
]

Champs extraits​

  • document_type : "log_book"
  • formula : Le numéro de formule ou d'identification spécifique au document. Il s'agit d'une séquence alphanumérique utilisée pour identifier le document.
  • issue_date : La date de délivrance du document, indiquant quand il a été émis.
  • last_name : Le nom de famille du titulaire du document.
  • license_plate : Le numéro de plaque d'immatriculation du véhicule associé.
  • mrz_bottom : La ligne inférieure du code MRZ (Machine Readable Zone), qui contient des informations codées sur le document ou le véhicule.
  • mrz_top : La ligne supérieure du code MRZ (Machine Readable Zone), contenant d'autres informations codées sur le véhicule.
  • prenoms : Les prénoms du titulaire du document.
  • registration_date : La date d'enregistrement initiale du véhicule.
  • second_name : Le second nom ou nom complémentaire du titulaire du document (nom composé, nom de famille supplémentaire).
  • vehicle_identification_number : Le numéro d'identification unique du véhicule (VIN - Vehicle Identification Number).
  • vehicle_type : Le type ou le modèle du véhicule.

4. Certificat provisoire d'immatriculation​

Le Certificat Provisoire d'Immatriculation (CPI) est un document temporaire qui permet à un véhicule de circuler en attendant la délivrance de la carte grise définitive. Il contient des informations similaires à la carte grise, comme le numéro d'immatriculation provisoire, les informations du propriétaire, et les détails du véhicule. L'API renverra les informations suivantes :

Exemple de réponse​

[
    {
        "document_type": "tempVehicleReg",
        "page_index": [
            0
        ],
        "read_success": true,
        "values": {
            "first_name": "NICOLAS",
            "last_name": "DUPONT",
            "license_plate": "AB-123-CD",
            "registration_date": "23/11/2021"
        }
    }
]

Champs extraits​

  • document_type : "tempVehicleReg"
  • first_name : Le prénom du titulaire du document ou du véhicule.
  • last_name : Le nom de famille du titulaire du document.
  • license_plate : Le numéro de plaque d'immatriculation provisoire du véhicule.
  • registration_date : La date d'enregistrement ou de mise en circulation du véhicule.

5. Carte identitié ancien format "Recto"​

La Carte d'identité ancien format (Recto) est une pièce d'identité française délivrée avant le nouveau format biométrique. Le recto de la carte contient des informations personnelles telles que le nom, le prénom, la date de naissance, et la nationalité du titulaire. L'API renverra les informations suivantes :

Exemple de réponse​

[
    {
        "document_type": "cni_front",
        "page_index": [
            0
        ],
        "read_success": true,
        "values": {
            "born": "03/04/1962",
            "born_city": "DUGNY",
            "first_name": "SOPHIE MARIE CHRISTINE",
            "gender": "F",
            "issued_date": "31/10/2004",
            "last_name": "ROBERT",
            "number": "041095202910",
            "preferred_name": ""
        }
    }
]

Champs extraits​

  • document_type : "cni_front"
  • born : La date de naissance du titulaire du document.
  • born_city : La ville de naissance du titulaire du document.
  • first_name : Le ou les prénoms du titulaire du document.
  • gender : Le genre du titulaire du document (F pour féminin, M pour masculin).
  • issued_date : La date de délivrance de la carte d'identité.
  • last_name : Le nom de famille du titulaire du document.
  • number : Le numéro unique de la carte d'identité.
  • preferred_name : Le nom maritale du titulaire (ce champ peut être vide si non applicable).

6. Carte identitié nouveau format "Verso"​

La Carte d'identité nouveau format (Recto), aussi appelée carte d'identité biométrique, est le modèle actuel de la carte d'identité nationale française. Le recto de cette carte contient des informations personnelles du titulaire telles que le nom, le prénom, la date et le lieu de naissance, ainsi que la nationalité. L'API renverra les informations suivantes :

Exemple de réponse​

[
    {
        "document_type": "cni2021_back",
        "page_index": [
            0
        ],
        "read_success": true,
        "values": {
            "born": "13/07/1990",
            "first_name": "MAELYS GAELLE MARIE",
            "gender": "F",
            "issued_date": "12/02/2020",
            "last_name": "MARTIN",
            "number": "X4RTBPFW4"
        }
    }
]

Champs extraits​

  • document_type : "cni2021_back"
  • born : La date de naissance du titulaire du document.
  • first_name : Le ou les prénoms du titulaire du document.
  • gender : Le genre du titulaire du document (F pour féminin, M pour masculin).
  • issued_date : La date de délivrance de la carte d'identité.
  • last_name : Le nom de famille du titulaire du document.
  • number : Le numéro unique de la carte d'identité.

7. Carte identitié nouveau format "Recto"​

La Carte d'identité nouveau format (Verso) contient des informations supplémentaires, telles que le numéro de la carte d'identité, la date de délivrance, ainsi que l'autorité qui a délivré le document. Le verso peut aussi inclure un code-barres et des éléments de sécurité supplémentaires. L'API renverra les informations suivantes :

Exemple de réponse​

[
    {
        "document_type": "cni2021_front",
        "page_index": [
            0
        ],
        "read_success": true,
        "values": {
            "born": "13/07/1990",
            "born_city": "PARIS",
            "expire": "11/02/2030",
            "first_name": "MAELYS GAELLE MARIE",
            "genre": "F",
            "last_name": "MARTIN",
            "preferred_name": ""
        }
    }
]

Champs extraits​

  • document_type : "cni2021_front"
  • born : La date de naissance du titulaire du document.
  • born_city : La ville de naissance du titulaire du document.
  • expire : La date d'expiration de la carte d'identité.
  • first_name : Le ou les prénoms du titulaire du document.
  • genre : Le genre du titulaire du document (F pour féminin, M pour masculin).
  • last_name : Le nom de famille du titulaire du document.
  • preferred_name : Le nom maritale du titulaire (ce champ peut être vide si non applicable).

8. Permis de conduire nouveau format "Recto"​

Le Permis de conduire nouveau format (Recto) est une version récente et sécurisée du permis de conduire en France. Il contient des informations personnelles telles que le nom, le prénom, la date de naissance, et le numéro du permis de conduire. Ce nouveau format est plus sécurisé et intègre des éléments biométriques. L'API renverra les informations suivantes :

Exemple de réponse​

[
    {
        "document_type": "drivers_license_2021_front",
        "page_index": [
            0
        ],
        "read_success": true,
        "values": {
            "born": "14/07/1981",
            "born_city": "PARIS",
            "expire": "31/12/2018",
            "first_name": "DUPOND",
            "last_name": "MARTIN",
            "number": "13AA00002"
        }
    }
]

Champs extraits​

  • document_type : "drivers_license_2021_front"
  • born : La date de naissance du titulaire du permis de conduire.
  • born_city : La ville de naissance du titulaire du permis de conduire.
  • expire : La date d'expiration du permis de conduire.
  • first_name : Le ou les prénoms du titulaire du permis de conduire.
  • last_name : Le nom de famille du titulaire du permis de conduire.
  • number : Le numéro unique du permis de conduire.

9. Permis de conduire nouveau format "Verso"​

Le Permis de conduire nouveau format (Verso) inclut les catégories de véhicules que le titulaire est autorisé à conduire, ainsi que les dates de validité pour chaque catégorie. Il peut également inclure des informations complémentaires telles que des restrictions ou des observations. L'API renverra les informations suivantes :

Exemple de réponse​

[
    {
        "document_type": "drivers_license_2021_back",
        "page_index": [
            0
        ],
        "read_success": true,
        "values": {
            "date_of_issue_category_b": "01/01/2000",
            "license_restriction_code": false
        }
    }
]

Champs extraits​

  • date_of_issue_category_b : La date de délivrance du permis pour la catégorie B (véhicules légers).
  • license_restriction_code : Indique s'il existe des restrictions associées au permis de conduire. (true ou false).

10. Passeport​

Le Passeport est un document de voyage officiel délivré par les autorités gouvernementales, utilisé pour identifier le titulaire et lui permettre de voyager à l'étranger. Il contient des informations personnelles telles que le nom, le prénom, la date de naissance, la nationalité, et le numéro de passeport. Ce document inclut également des éléments biométriques dans les versions les plus récentes. L'API renverra les informations suivantes :

Exemple de réponse​

[
    {
        "document_type": "passeport",
        "page_index": [
            0
        ],
        "read_success": true,
        "values": {
            "born": "30/09/1979",
            "born_city": "PARIS",
            "expire": "22/03/2030",
            "first_name": "ANTOINE MICHEL GEORGES",
            "genre": "M",
            "last_name": "DUPONT",
            "number": "22FG83746",
            "preferred_name": ""
        }
    }
]

Champs extraits​

  • document_type : "passeport"
  • born : La date de naissance du titulaire du passeport.
  • born_city : La ville de naissance du titulaire du passeport.
  • expire : La date d'expiration du passeport.
  • first_name : Le ou les prénoms du titulaire du passeport.
  • genre : Le genre du titulaire (M pour masculin, F pour féminin).
  • last_name : Le nom de famille du titulaire du passeport.
  • number : Le numéro unique du passeport.
  • preferred_name : Le nom maritale du titulaire (ce champ peut être vide si non applicable).

11. IBAN​

L'IBAN (International Bank Account Number) est un numéro de compte bancaire international normalisé, utilisé pour identifier un compte spécifique dans une banque. Il est composé d'une série de lettres et de chiffres représentant le pays, la banque et le numéro de compte du titulaire. L'API renverra les informations suivantes :

Exemple de réponse​

[
    {
        "document_type": "iban",
        "page_index": [
            0
        ],
        "read_success": true,
        "values": {
            "iban": "FR76000000001111194847746154",
            "nom": "SAS DUPOND"
        }
    }
]

Champs extraits​

  • document_type : "iban"
  • iban : Le numéro de compte bancaire international (IBAN), qui identifie de manière unique le compte du titulaire.
  • nom : Le nom du titulaire du compte bancaire associé à l'IBAN.

12. Relevé d'information d'assurance​

Le Relevé d'information d'assurance est un document officiel délivré par une compagnie d'assurance. Il contient des informations détaillées sur le contrat d'assurance du titulaire, y compris l'historique des sinistres, le bonus-malus, les informations sur le véhicule assuré, ainsi que les périodes de couverture. Ce document est généralement utilisé lors du changement de compagnie d'assurance ou pour justifier l'historique d'un assuré. Lors du traitement, l'API renverra les informations suivantes :

Exemple de réponse​

[
    {
        "document_type": "insurance_record ",
        "page_index": [
            0
        ],
        "read_success": true,
        "values": {
            "accidents": [
                {
                    "date": "24/02/2021"
                },
                {
                    "date": "24/01/2020"
                },
                {
                    "date": "07/01/2019"
                },
                {
                    "date": "22/05/2018"
                },
                {
                    "date": "30/03/2018"
                }
            ],
            "bonus_credit": false,
            "cancellation_date": "",
            "crm_ratio": "0,50",
            "document_date": "23/11/2022",
            "full_name": "DUPOND MICHEL",
            "license_plate": "AB-123-CD",
            "number_of_claims": 5,
            "subscription_date": "03/08/2016"
        }
    }
]

Champs extraits​

  • document_type : "insurance_record"
  • accidents : Une liste d'accidents signalés, avec les dates des sinistres associés.
  • bonus_credit : Indique si un bonus est accordé ou non (true ou false).
  • cancellation_date : La date d'annulation du contrat d'assurance (si applicable).
  • crm_ratio : Le coefficient de réduction majoration (CRM), également appelé "bonus-malus", qui indique le niveau de risque du titulaire.
  • document_date : La date de création ou d'émission du relevé d'information.
  • full_name : Le nom complet du titulaire du contrat d'assurance.
  • license_plate : Le numéro de plaque d'immatriculation du véhicule assuré.
  • number_of_claims : Le nombre total de sinistres déclarés par le titulaire.
  • subscription_date : La date de souscription initiale au contrat d'assurance.

13. Vérification d'un numéro de TVA (EP4)​

La route check-vat de l'Endpoint 4 permet de vérifier la validité d'un numéro de TVA intracommunautaire (VAT) pour les entreprises enregistrées dans l'Union européenne. Cette vérification vous retourne les informations associées à l'entreprise et vous confirme si le numéro de TVA est valide ou non.

Exemple de réponse​

[
    {
        "valid": true,
        "countryCode": "FR",
        "vatNumber": "12345678901",
        "requestDate": "2024-11-13T10:41:39.741Z",
        "name": "SAS ENTREPRISE",
        "address": "PARC ENTREPRISE, RUE OMAJVA, 28630 LE COUDRAY"
    }
]

Champs extraits​

  • valid : Indique si le numéro de TVA est valide (true ou false).
  • countryCode : Code pays ISO 3166-1 à deux lettres, représentant le pays d'enregistrement de l'entreprise (exemple : "FR" pour la France).
  • vatNumber : Le numéro de TVA intracommunautaire de l'entreprise vérifiée, sans le code pays.
  • requestDate : La date et l'heure de la demande de vérification (au format ISO 8601).
  • name : Le nom de l'entreprise associée au numéro de TVA.
  • address : L'adresse complète de l'entreprise, telle que retournée par l'API.

14. Vérification d'un numéro IBAN (EP5)​

La route check-iban de l'Endpoint 5 permet de vérifier la validité d'un numéro IBAN et de retourner des informations détaillées sur l'IBAN ainsi que sur la banque associée. Cette vérification inclut plusieurs étapes de validation pour s'assurer de l'exactitude des données bancaires.

Exemple de réponse​

[
    {
        "bank_detected": "Caisse D'Epargne",
        "bank_code": "13825",
        "bank_name": "caisse d'epargne et de prevoyance de rhone alpes",
        "iban_number": "FR7613825002000999999999999",
        "country": "FR",
        "score": "100%"
    }
]

Champs extraits​

  • bank_detected : Le nom de la banque détecté via l'analyse du logo sur le document.
  • bank_code : Le code de la banque extrait de l'IBAN (5 caractères pour les banques françaises).
  • bank_name : Le nom complet de la banque associé au code banque.
  • iban_number : Le numéro IBAN complet, incluant le code pays et le code banque.
  • country : Le code pays ISO à deux lettres (exemple : "FR" pour la France).
  • score : Le score de validité de l'IBAN, exprimé en pourcentage, basé sur plusieurs points de pondération interne.