{"swagger":"2.0","host":"arkeapi","basePath":"/v1/","info":{"title":"Persons","description":"API de gestion des personnes (physiques ou morales).","version":"1.0","license":{"name":"ARKEA","url":"https://developer.arkea.com/"},"contact":{"name":"ARKEA PI Team","email":"openbanking@arkea.com"},"x-logo":{"altText":"Monext logo","url":"https://i.ibb.co/ypy99Qw/person.png","backgroundColor":"#FFFFFF"}},"x-servers":[{"url":"https://api-arkea-monext.s.arkea.com:8443","description":"Production"},{"url":"https://api-arkea-monext.hml.s.arkea.com:8443","description":"Homologation"},{"url":"//api-arkea-monext.rec.s.arkea.com:8080/","description":"Sandbox"}],"schemes":["https"],"produces":["application/json"],"securityDefinitions":{"arkeaOAuth":{"type":"oauth2","description":"authentification oAuth2","flow":"accessCode","authorizationUrl":"https://d/oauth","tokenUrl":"https://d/token","scopes":{"Server":"Approche de type serveur","User":"Approche de type utilisateur"}}},"security":[{"arkeaOAuth":["Server"]}],"paths":{"/persons/{personId}":{"parameters":[{"type":"string","in":"path","required":true,"name":"personId","pattern":"^[a-zA-Z0-9-]*$"}],"get":{"summary":"Récupére les information d'une personne existante","description":"# Paramètres\n* personId: Identifiant de la personne\n\n# Réponse\nLe détail d'une personne (physique ou légale) si le personId fourni est valide, sinon retourne une erreur.","responses":{"200":{"description":"Retourne la personne","examples":{"legal-person":"{\n        \"birthDate\": \"2010-09-19\",\n        \"id\": \"Sm9zZXBoIFJvYmlsbGFyZA==\",\n        \"type\": \"legal\",\n        \"label\": \"Acme Business\",\n        \"corporateName\": \"Acme\",\n        \"createdAt\": \"2017-03-31T11:08:07.227Z\"\n}","physical-person":"{\n        \"id\": \"Sm9zZXBoIFJvYmlsbGFyZA==\",\n        \"type\": \"physical\",\n        \"label\": \"Joseph Robillard\",\n        \"birthDate\": \"1989-08-27\",\n        \"gender\": \"male\",\n        \"lastName\": \"Robillard\",\n        \"firstName\": \"Joseph\",\n        \"middleName\": \"Jean\",\n        \"birthName\": \"Bertrand\",\n        \"legalCapacity\": \"\",\n        \"representatives\":\n                [\n                                {\n                                                \"personId\": \"132x456=\",\n                                                \"role\": \"representative\",\n                                                \"id\": \"321sf/$\",\n                                                \"label\": \"REPRESENTATIVE 1\"\n                                },\n                                {\n                                                \"personId\": \"sdsd123-\",\n                                                \"role\": \"representative\",\n                                                \"id\": \"-$44323\",\n                                                \"label\": \"REPRESENTATIVE 2\"\n                                }\n                ],\n        \"mentees\":\n                [\n                                {\n                                                \"personId\": \"122x452=\",\n                                                \"role\": \"child\",\n                                                \"id\": \"141sd$-\",\n                                                \"label\": \"child 1\"\n                                }\n                ],\n        \"createdAt\": \"2017-03-31T11:08:07.227Z\"\n}"},"schema":{"anyOf":[{"$ref":"#/definitions/legalPerson"},{"$ref":"#/definitions/physicalPerson"}]}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}}},"/persons/{personId}/addresses":{"parameters":[{"type":"string","in":"path","required":true,"name":"personId","pattern":"^[a-zA-Z0-9-]*$"}],"get":{"summary":"Liste toutes les adresses d'une personne","description":"# Paramètres\n* personId: Identifiant de la personne\n* range: Intervalle de pagination souhaité i.e les resources d'un index donné à un autre inclus (ex:de 10 à 25 => ?range = 10-25).\n\n# Réponse\nUn tableau détaillé d'adresses en relation avec la personne demandée si le personId fourni est valide, sinon retourne une erreur..\nChaque élément du tableau est un objet adresse. Si aucune adresse est disponible, le tableau est vide.","responses":{"200":{"description":"Retourne les adresses","examples":{"application/json":"[\n        {\n                \"label\": \"30 RUE LEDRU ROLLIN\",\n                \"address\": {\n                        \"address1\": \"30 RUE LEDRU ROLLIN\",\n                        \"city\": \"RENNES\",\n                        \"countryCode\": \"FRA\",\n                        \"postalCode\": \"35000\"\n                },\n                \"prefered\": true\n        },\n        {\n                \"label\": \"2 RUE DE SIAM\",\n                \"address\": {\n                        \"address1\": \"2 RUE DE SIAM\",\n                        \"city\": \"BREST\",\n                        \"countryCode\": \"FRA\",\n                        \"postalCode\": \"29200\"\n                },\n                \"prefered\": false\n        }\n]"},"schema":{"type":"array","items":{"$ref":"#/definitions/personAddress"}}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}}},"/persons/{personId}/emails":{"parameters":[{"type":"string","in":"path","required":true,"name":"personId","pattern":"^[a-zA-Z0-9-]*$"}],"get":{"summary":"Liste toutes les adresses emails liés à la personne","description":"# Paramètres\n* personId: Identifiant de la personne\n* range: Intervalle de pagination souhaité i.e les resources d'un index donné à un autre inclus (ex:de 10 à 25 => ?range = 10-25).\n\n# Réponse\nUn tableau détaillé d'adresses emails en relation avec la personne demandée si le personId fourni est valide, sinon retourne une erreur..\nChaque élément du tableau est un objet adresse email. Si aucune adresse email est disponible, le tableau est vide.","responses":{"200":{"description":"Retourne les emails","examples":{"application/json":"[\n        {\n                \"email\": {\n                        \"value\": \"MAIL@ANONYMISE.COM\"\n                },\n                \"label\": \"MAIL@ANONYMISE.COM\",\n                \"usage\": \"professional\",\n                \"prefered\": false\n        },\n        {\n                \"email\": {\n                        \"value\": \"ANONYMISE@MAIL.COM\"\n                },\n                \"label\": \"ANONYMISE@MAIL.COM\",\n                \"usage\": \"private\",\n                \"prefered\": true\n        }\n]"},"schema":{"type":"array","items":{"$ref":"#/definitions/personEmail"}}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}}},"/persons/{personId}/phoneNumbers":{"parameters":[{"type":"string","in":"path","required":true,"name":"personId","pattern":"^[a-zA-Z0-9-]*$"}],"get":{"summary":"Liste tous les numéros de téléphone d'une personne","description":"# Paramètres\n* personId: Identifiant de la personne\n* range: Intervalle de pagination souhaité i.e les resources d'un index donné à un autre inclus (ex:de 10 à 25 => ?range = 10-25).\n\n# Réponse\nUn tableau détaillé de numéros de téléphones en relation avec la personne demandée si le personId fourni est valide, sinon retourne une erreur.\nChaque élément du tableau est un objet numéro de téléphone. Si aucun numéro de téléphone n'est disponible, le tableau est vide.","responses":{"200":{"description":"Retourne les numéros de téléphone","examples":{"application/json":"[\n        {\n                \"label\": \"WORK\",\n                \"phoneNumber\": {\n                        \"value\": \"0660662494\"\n                },\n                \"usage\": \"professionnal\",\n                \"prefered\": true\n        },\n        {\n                \"label\": \"HOME\",\n                \"phoneNumber\": {\n                        \"value\": \"0203010406\"\n                },\n                \"usage\": \"private\",\n                \"prefered\": false\n        }\n]"},"schema":{"type":"array","items":{"$ref":"#/definitions/personPhoneNumber"}}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}}},"/persons/{personId}/representatives":{"parameters":[{"type":"string","in":"path","required":true,"name":"personId","pattern":"^[a-zA-Z0-9-]*$"}],"get":{"summary":"Liste tous les représentant d'une personne","description":"# Paramètres\n* personId: Identifiant de la personne\n* range: Intervalle de pagination souhaité i.e les resources d'un index donné à un autre inclus (ex:de 10 à 25 => ?range = 10-25).\n\n# Réponse\nUn tableau détaillé de représentants en relation avec la personne demandée si le personId fourni est valide, sinon retourne une erreur..\nChaque élément du tableau est un objet représentant. Si aucun représentant n'est disponible, le tableau est vide.","responses":{"200":{"description":"Retourne les représentants","examples":{"application/json":"[\n        {\n                \"personId\": \"132x456=\",\n                \"role\": \"representative\",\n                \"id\": \"321sf/$\",\n                \"label\": \"REPRESENTATIVE 1\"\n        },\n        {\n                \"personId\": \"sdsd123-\",\n                \"role\": \"representative\",\n                \"id\": \"-$44323\",\n                \"label\": \"REPRESENTATIVE 2\"\n        }\n]"},"schema":{"type":"array","items":{"$ref":"#/definitions/personRepresentative"}}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}}},"/persons/{personId}/accounts":{"parameters":[{"type":"string","in":"path","required":true,"name":"personId","description":"Identifiant de la personne souhaitée","pattern":"^[a-zA-Z0-9-]*$"}],"get":{"summary":"Renvoie tous les comptes associés à la personne demandée","description":"# Paramètres\n* personId: Identifiant de la personne\n* range: Intervalle de pagination souhaité i.e les resources d'un index donné à un autre inclus (ex:de 10 à 25 => ?range = 10-25).\n\n# Réponse\nUn tableau détaillé de comptes bancaires en relation avec la personne demandée si le personId fourni est valide, sinon retourne une erreur..\nChaque élément du tableau est un objet compte détaillé. Si aucun compte n'est disponible, le tableau sera vide.","responses":{"200":{"description":"Tableau renvoyé si réponse positive","examples":{"application/json":"[\n  {\n    \"id\": \"QWNtZQ==\",\n    \"label\": \"Acme Business Account\",\n    \"productId\": \"business-account\",\n    \"participants\": [\n      {\n        \"person\": {\n          \"id\": \"Sm9zZXBoIFJvYmlsbGFyZA==\",\n          \"personType\": \"natural\",\n          \"label\": \"Manon Fugère\"\n        },\n        \"role\": \"holder\"\n      },\n      {\n        \"person\": {\n          \"id\": \"UGhpbGlwIEJlYXVjaGFtcA==\",\n          \"personType\": \"natural\",\n          \"label\": \"Philip Beauchamp\"\n        },\n        \"role\": \"representative\"\n      }\n    ],\n    \"balances\": [\n      {\n        \"label\": \"Current\",\n        \"amount\": [\n          {\n            \"currency\": \"EUR\",\n            \"value\": \"457.45\"\n          }\n        ],\n        \"date\": \"2017-07-15\"\n      }\n    ]\n  },\n  {\n    \"id\": \"c2Vjb25kQWNjb3VudA==\",\n    \"label\": \"CDOS Business Account\",\n    \"productId\": \"business-account\",\n    \"participants\": [\n      {\n        \"person\": {\n          \"id\": \"Sm9zZXBoIFJvYmlsbGFyZA==\",\n          \"personType\": \"natural\",\n          \"label\": \"Manon Fugère\"\n        },\n        \"role\": \"holder\"\n      }\n    ],\n    \"balances\": [\n      {\n        \"id\": \"78Y1NDEzMjU0NTe8\",\n        \"label\": \"Current\",\n        \"amount\": [\n          {\n            \"currency\": \"EUR\",\n            \"value\": \"57.12\"\n          }\n        ],\n        \"date\": \"2017-07-15\"\n      }\n    ]\n  }\n]"},"schema":{"type":"array","items":{"$ref":"#/definitions/accountAsShort"}}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}}},"/person/{personId}/documents":{"parameters":[{"type":"string","in":"path","required":true,"name":"personId","pattern":"^[a-zA-Z0-9-]*$"}],"get":{"summary":"Liste tous les documents d'un personne","description":"# Arguments\n* personId: Identifiant de la personne\n* range: Intervalle de pagination souhaité i.e les resources d'un index donné à un autre inclus (ex:de 10 à 25 => ?range = 10-25).\n\n# Réponse\nUn tableau de détails sur les documents d'une personne si le personId fourni est valide, sinon renvoi une erreur.\nChaque entrée du tableau est un détil de document, si aucun document est disponible, le tableau est vide.","responses":{"200":{"description":"Documents de la personne","examples":{"application/json":"[\n        {\n                \"label\": \"CTR_ACEP_001_20180731.pdf\",\n                \"size\": {\n                        \"number\": \"128\",\n                        \"format\": \"bytes\"\n                },\n                \"mimeType\": \"image/png\",\n                \"lastAccessDate\": \"2019-04-25T02:32:07.352Z\",\n                \"id\": \"MQ==\",\n                \"createdAt\": \"2006-02-04T02:39:21.155Z\"\n        },\n        {\n                \"label\": \"CSN_001_20180628.pdf\",\n                \"size\": {\n                        \"number\": \"256\",\n                        \"format\": \"bytes\"\n                },\n                \"mimeType\": \"application/pdf\",\n                \"lastAccessDate\": \"2019-04-25T02:32:07.352Z\",\n                \"id\": \"Mg==\",\n                \"createdAt\": \"2019-04-24T02:32:07.352Z\"\n        },\n        {\n                \"label\": \"CSN_LIV2_001_20171127.pdf\",\n                \"size\": {\n                        \"number\": \"1024\",\n                        \"format\": \"bytes\"\n                },\n                \"mimeType\": \"application/pdf\",\n                \"lastAccessDate\": \"2019-04-25T02:32:07.352Z\",\n                \"id\": \"Mw==\",\n                \"createdAt\": \"2008-09-26T20:35:12.673Z\"\n        }\n]"},"schema":{"type":"array","items":{"$ref":"#/definitions/document"}}},"400":{"$ref":"#/responses/400-BadRequest"},"401":{"$ref":"#/responses/401-Unauthorized"},"403":{"$ref":"#/responses/403-Forbidden"},"404":{"$ref":"#/responses/404-NotFound"},"429":{"$ref":"#/responses/429-TooManyRequests"},"500":{"$ref":"#/responses/500-InternalServerError"}}}}},"responses":{"400-BadRequest":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 400,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T17:32:32.983Z\",\n  \"fishtag\": \"OTg1NjQ4NDU0Nw\",\n  \"messages\": [\n    {\n      \"code\": \"missing_param\",\n      \"doc_url\": \"https://arkeaopenbanking.com/documentation/codes/missing_param\",\n      \"message\": \"Missing parameter: name\"\n    }\n  ]\n}"}},"401-Unauthorized":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 401,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T15:21:32.983Z\",\n  \"fishtag\": \"NDU4Nzg1MjY\",\n  \"messages\": [\n    {\n      \"code\": \"invalid_token\",\n      \"doc_url\": \"https://arkeaopenbanking.com/documentation/auth\",\n      \"message\": \"Invalid token\"\n    }\n  ]\n}"}},"403-Forbidden":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 403,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T17:47:48.983Z\",\n  \"fishtag\": \"NTg5NzQ1MTIzOQ\",\n  \"messages\": [\n    {\n      \"code\": \"forbiden\",\n      \"message\": \"Forbiden access\"\n    }\n  ]\n}"}},"404-NotFound":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 404,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T17:12:32.983Z\",\n  \"fishtag\": \"NTU1ODc0OTU4Ng\",\n  \"messages\": [\n    {\n      \"code\": \"resource_not_found\",\n      \"message\": \"Specified resource does not exist\"\n    }\n  ]\n}"}},"409-Conflict":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 409,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T10:12:32.983Z\",\n  \"fishtag\": \"Njk4NTY5ODU2Nw\",\n  \"messages\": [\n    {\n      \"code\": \"conflict\",\n      \"message\": \"A resource with the same name already exist\"\n    }\n  ]\n}"}},"429-TooManyRequests":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 429,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T23:23:32.983Z\",\n  \"fishtag\": \"MjIyMjI1ODc0NQ\",\n  \"messages\": [\n    {\n      \"code\": \"too_many_request\",\n      \"message\": \"Too many request, wait and retry\"\n    }\n  ]\n}"}},"500-InternalServerError":{"description":"","schema":{"$ref":"#/definitions/APIError"},"examples":{"application/json":"{\n  \"httpcode\": 500,\n  \"url\": \"/resource\",\n  \"errordate\": \"2019-08-10T11:02:32.983Z\",\n  \"fishtag\": \"MzU3MzU3MzU3Mw\",\n  \"messages\": [\n    {\n      \"code\": \"internal_server_error\",\n      \"message\": \"Your request is surely right but an issue occures on Arkéa server side, try again later\"\n    }\n  ]\n}"}}},"definitions":{"legalPerson":{"title":"Personne légale","description":"Définition d'une personne légale.","allOf":[{"$ref":"#/definitions/person"},{"type":"object","properties":{"corporateName":{"type":"string","title":"Nom de l'entreprise","maxLength":32,"example":"EXAMPLE INC."},"representatives":{"type":"array","description":"Représentants de la personne","items":{"$ref":"#/definitions/personRepresentative"}}}},{"$ref":"#/definitions/technicalInformations"}],"required":["corporateName"]},"physicalPerson":{"title":"Personne physique","description":"Définition d'une personne physique","allOf":[{"$ref":"#/definitions/person"},{"type":"object","properties":{"gender":{"$ref":"#/definitions/personGender"},"lastName":{"type":"string","description":"Nom de famille de la personne","maxLength":32,"example":"HAPPY"},"firstName":{"type":"string","description":"Prénom de la personne","maxLength":32,"example":"Liam"},"middleName":{"type":"string","description":"Deuxième prénom de la personne","maxLength":32,"example":"John"},"birthName":{"type":"string","description":"Nom de naissance","maxLength":32,"example":"MARTIN"},"legalCapacity":{"type":"string","description":"Capacité juridique de la personne (comme défini par la loi)"},"representatives":{"type":"array","description":"Représentants de la personne","items":{"$ref":"#/definitions/personRepresentative"}},"mentees":{"type":"array","description":"Représentés associés à la personne","items":{"$ref":"#/definitions/personMentee"}}}},{"$ref":"#/definitions/technicalInformations"}]},"personAddress":{"type":"object","properties":{"label":{"$ref":"#/definitions/label"},"address":{"$ref":"#/definitions/address"},"prefered":{"type":"boolean","description":"Est ce l'adresse préférée de la personne ?","example":"true"}},"title":"Adresse d'une personne","description":"Adresse relative à une personne (physique ou morale)","required":["label","address"]},"personEmail":{"type":"object","properties":{"label":{"$ref":"#/definitions/label"},"email":{"$ref":"#/definitions/email"},"usage":{"type":"string","description":"Utilisation de l'adresse email","enum":["private","professional"],"example":"professional"}},"title":"Email de la personne","description":"Défintion de l'adresse email d'une personne (légale ou physique)"},"personPhoneNumber":{"type":"object","properties":{"label":{"$ref":"#/definitions/label"},"phoneNumber":{"$ref":"#/definitions/phoneNumber"},"usage":{"type":"string","description":"Usage du numéro de téléphone (privé ou professionnel)","enum":["private","professional"],"example":"private"},"prefered":{"type":"boolean","description":"Est ce le numéro préféré de la personne ?","example":"true"}},"title":"Numéro de téléphone de la personne","description":"Défintion du numéro de téléphone de la personne","required":["label","phoneNumber","usage"]},"personRepresentative":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique du représentant"},"label":{"$ref":"#/definitions/label"},"personId":{"type":"string","description":"Identifiant unique de la personne"},"roles":{"type":"array","items":{"$ref":"#/definitions/personRepresentativeRole"}},"createdAt":{"type":"string","description":"Date de création","format":"date-time","example":"2019-10-02T08:11:07.480Z"}},"title":"Représentant d'une personne"},"accountAsShort":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique de compte"},"label":{"$ref":"#/definitions/label"},"type":{"type":"string","description":"Type de compte","enum":["business-account"],"example":"business-account"},"productId":{"type":"string","description":"Identifiant unique de produit","example":"xDYTDyDT"},"iban":{"type":"string","description":"International Bank Account Number","example":"FR7615589009101234567890147"},"participants":{"type":"array","description":"Participants","items":{"$ref":"#/definitions/accountParticipant"}},"balances":{"type":"array","items":{"$ref":"#/definitions/balanceAsShort"}},"closingDate":{"type":"string","description":"Date de fermeture","format":"date","example":"2019-10-02T08:11:08.165Z"}},"title":"Compte","description":"Définition d'un compte"},"document":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique du document"},"label":{"$ref":"#/definitions/label"},"type":{"$ref":"#/definitions/documentType"},"size":{"$ref":"#/definitions/fileSize"},"mimeType":{"$ref":"#/definitions/documentMimeType"},"lastAccessDate":{"type":"string","description":"Date de dernier accès","format":"date-time","example":"2019-10-02T08:11:08.924Z"},"createdAt":{"type":"string","description":"Date de création","format":"date-time","example":"2019-10-02T08:11:08.925Z"}},"title":"Document","description":"Définition d'un document"},"APIError":{"type":"object","properties":{"httpcode":{"type":"integer","description":"Code statut HTTP","format":"int32","example":"500"},"url":{"type":"string","description":"URL appelée","example":"/accounts/NDU2NDE2ODc1NDU1MTg3NA/transactions"},"errordate":{"type":"string","description":"Date d'erreur de création","format":"date-time","example":"2019-10-02T08:11:09.598Z"},"fishtag":{"type":"string","description":"Identifiant unique de transaction","example":"RandomTextIdentifier564"},"messages":{"type":"array","description":"Message retourné par l'appel API","items":{"$ref":"#/definitions/APIMessage"}}},"title":"ErreurAPI","description":"Définition de la structure de message d'erreur standard API\nUtilisée pour le code de retour 400.","required":["httpcode","url"]},"person":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique de la personne"},"type":{"type":"string","description":"Type de personne (physique ou morale)","example":"legal"},"label":{"$ref":"#/definitions/label"},"birthDate":{"type":"string","description":"Date de naissance de la personne","format":"date","example":"2019-10-2"}},"x-extendedDiscriminator":"type","title":"Personne","description":"Définition de la personne (physique ou légale).","required":["type"]},"technicalInformations":{"type":"object","properties":{"createdAt":{"type":"string","description":"Date de création","format":"date-time","example":"2019-10-02T08:11:11.006Z"}},"title":"Informations techniques","description":"Informations techniques pour les champs de création/mise à jour/suppression"},"personGender":{"type":"string","title":"Genre de la personne (Enum)","description":"Le type de genre d'une personne physique\n\nTypes\n* male\n* female","enum":["male","female"]},"personMentee":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique du représenté"},"label":{"$ref":"#/definitions/label"},"personId":{"type":"string","description":"Identifiant de personne du représenté"},"roles":{"type":"array","items":{"$ref":"#/definitions/personMenteeRole"}}},"title":"Personne représentée","description":"Définition d'une personne représentée\nLe représenté est la personne à la charge du représentant.","required":["personId"]},"label":{"type":"string","title":"Libellé","description":"Définition du label"},"address":{"type":"object","properties":{"label":{"$ref":"#/definitions/label"},"address1":{"type":"string","description":"Numéro et voie","example":"5 place Georges Méliès"},"address2":{"type":"string","description":"Détails additionnels","example":"Bâtiment B, Escalier C"},"postalCode":{"type":"string","description":"Code postal","example":"29200"},"city":{"type":"string","description":"Ville","example":"BREST"},"countryCode":{"type":"string","description":"Code pays (Alpha 3)","example":"FRA"}},"title":"Adresse","description":"Définition d'une adresse postale"},"email":{"type":"object","properties":{"value":{"type":"string","description":"Adresse email","example":"marie.martin@exemple.com"}},"title":"Email","description":"Définition d'un email"},"phoneNumber":{"type":"object","properties":{"value":{"type":"string","description":"Valeur au format E.164","pattern":"^\\\\+?[1-9]\\\\d{1,14}$","maxLength":24},"type":{"$ref":"#/definitions/phoneNumberType"}},"title":"Numéro de téléphone","description":"Définition d'un numéro de téléphone."},"personRepresentativeRole":{"type":"string","title":"Role de la personne représentative (Enum)","description":"Le type de représentant\n\n# Cas des personnes morales:\n* employee\n* collaborator\n* spouse\n* entrepreneur\n* founder\n* director\n* participant\n* administrator \n* executive\n* associate \n* manager \n* chief-executive\n* president\n* deputy-president \n* treasurer\n* deputy-treasurer \n* secretary\n* deputy-secretary\n\n# Cas des personnes physiques:\n* legal-guardian\n* subrogate\n* trustee\n* representative\n* parent","enum":["employee","collaborator","spouse","entrepreneur","founder","director","participant","administrator","executive","associate","manager","chief-executive","president","deputy-president","treasurer","deputy-treasurer","secretary","deputy-secretary","legal-guardian","subrogate","trustee","","representative","parent"]},"accountParticipant":{"type":"object","properties":{"person":{"$ref":"#/definitions/personAsShort"},"role":{"$ref":"#/definitions/accountRole"}},"title":"Participant de compte","description":"Défintion d'un participant de compte."},"balanceAsShort":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique de solde"},"label":{"$ref":"#/definitions/label"},"type":{"$ref":"#/definitions/balanceType"},"amount":{"$ref":"#/definitions/amount"},"date":{"type":"string","description":"Date du solde","format":"date-time","example":"2019-10-02T08:11:17.540Z"},"createdAt":{"type":"string","description":"Date de création","format":"date-time","example":"2019-10-02T08:11:17.540Z"}},"title":"Solde d'un compte","description":"Définition du solde d'un compte."},"documentType":{"type":"string","title":"Type de document (Enum)","description":"Le type de document\n\nTypes:\n* bank-statement\n* fees-statement\n* invoice","enum":["bank-statement","fees-statement","invoice"]},"fileSize":{"type":"object","properties":{"number":{"type":"string","description":"Taille du fichier au format d'unité de valeur"},"format":{"type":"string","description":"Unité de valeur"}},"title":"Taille du document","description":"Défintion de la taille d'un document"},"documentMimeType":{"type":"string","title":"Types de documents, format MIME (Enum)","description":"Les types de documents au format MIME\n\nDifférents types de documents :\n* application/pdf: format PDF\n* image/png: format png\n* image/jpg: format jpg","enum":["application/pdf","image/png","image/jpg"]},"APIMessage":{"type":"object","properties":{"code":{"type":"string","description":"Code de message d'erreur court","example":"missing_param"},"level":{"type":"string","description":"Lien vers la documentation détaillant l'erreur","enum":["INFO, WARNING, ERROR"],"example":"ERROR"},"message":{"type":"string","description":"Détail de l'erreur","example":"Missing parameter: currency"}},"title":"MessageAPI","description":"Définition de la structure de message standard API\nUtilisée pour tous les codes de retours à l'exception des 2XX."},"personMenteeRole":{"type":"string","title":"Relation de la personne protégée (Enum)","description":"Le type de relation avec la personne protégée.\n\nType de relation:\n* child\n* company\n* guardianship","enum":["child","company","guardianship"]},"phoneNumberType":{"type":"string","title":"Type de numéro de téléphone","description":"Le type de numéro de téléphone.\n\nLes types possibles sont:\n* mobile: ligne mobile\n* fixed-line: ligne fixe","enum":["mobile","fixed-line"]},"personAsShort":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique de la personne"},"type":{"type":"string","description":"Type de personne (physique ou morale)","example":"legal"},"label":{"$ref":"#/definitions/label"},"birthDate":{"type":"string","description":"Date de naissance de la personne","format":"date","example":"2019-10-2"}},"x-extendedDiscriminator":"type","title":"Personne (simplifiée)","description":"Définition d'une personne (physique ou morale)"},"accountRole":{"type":"string","title":"Rôle d'un compte (Enum)","description":"Description des rôles des personnes associées à un compte.\n\nLes types de rôles possible sont:\n* holder: Le titulaire\n* co-holder: Le co-titulaire\n* representative: Un représentant du compte. Il est habilité légalement à agir ou prendre des décisions au nom d'une autre personne ou d'un groupe de personnes.\n* trustee: Un mandataire du compte.  Il est habilité dans le cadre d'un mandat à agir ou prendre des décisions au nom d'une autre personne ou d'un groupe de personnes.\n* card-only: Une personne qui est habilitée à interagir avec le compte via une carte bancaire\n* web-only: Une personne qui est habilitée à interagir avec le compte via le site web de la banque","enum":["holder","co-holder","representative","trustee","card-only","web-only"]},"balanceType":{"type":"string","title":"Type de solde (enum)","description":"Le type de solde.\n\nTypes de soldes:\n* accounting\n* real-time\n* upcoming\n","enum":["accounting","real-time","upcoming"]},"amount":{"type":"object","properties":{"currency":{"type":"string","description":"Trois caractères basés sur la norme <a href=\"https://www.iso.org/fr/iso-4217-currency-codes.html\">ISO 4217</a>","pattern":"^[A-Z]{3,3}$","example":"EUR"},"value":{"type":"number","format":"double"}},"title":"Valeur monétaire","description":"Définition d'un montant","required":["currency","value"]}}}