Stancer documentation

English

Français

English

Français

Appearance

Documents à fournir ​

Récupérer la liste des documents à fournir ​

Utiliser l'endpoint GET /document-upload-url?company=<comp> pour récupérer la liste des documents à fournir pour une société :

python
import requests

url = "https://api-partners.stancer.com/api/partners/document-upload-url?company=comp_pQ2rLuQrMUwufhyqbzYXe58D"

payload = {}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.json())

Réponse :

json
{
    "company-documents": [
      {
        "document": "kbis",
        "upload-url": "https://api-partners.stancer.com/api/partners/document/HdgTAvnducNbK7PqJPw7se5kqx3Yrw"
      },
      {
        "document": "iban",
        "upload-url": "https://api-partners.stancer.com/api/partners/document/7JQnjfKHDnfsr0MRwEAcddB3glWj7q"
      }
    ],
    "identity-documents": [
      {
        "address": "10 rue",
        "city": "Paris",
        "country": "fra",
        "date-birth": "1991-01-28",
        "first-name": "Jean",
        "id": "pers_ixk24J12a8xEk4IirtGb3HQn",
        "last-name": "Dupont",
        "upload-url": "https://api-partners.stancer.com/api/partners/document/l2QGgbXIKjldpMlCTcLsNigd41tCsF",
        "zip-code": "75008"
      }
    ]
}

Vous pouvez également accéder à l'objet documents-to-upload après un GET|PATCH|POST /company.

Faites un POST ou PATCH sur le upload-url afin d'ajouter ou remplacer un document.

Ajouter un document pour une société ​

Chaque document attendu à un upload-url défini que vous pouvez utiliser pour ajouter un document.

Vous pouvez accéder à cet upload-url via un GET /document-upload-url?company=<comp> et effectuer un POST /upload-url.

Documents d'identité (facultatif) ​

Renseigner les documents d'identité est facultatif, l'utilisateur pourra les renseigner lors de la finalisation de son inscription.

Pour les documents d'identité vous devez passer un fichier meta JSON avec les informations suivantes :

  • date-expiry : date d'expiration du document
  • date-issue : date d'émission du document
  • number : Numéro du document
json
{
  "date-expiry": "2025-12-01",
  "date-issue": "2022-03-01",
  "number": "X4RTBPFW4"
}

Pour l'ajout d'une carte d'identité vous devez envoyer le recto et verso du document :

Si le représentant et bénéficiaire sont la même personne le document s'ajoute par défaut au représentant.

python
import requests

url = "https://api-partners.stancer.com/api/partners/document/l2QGgbXIKjldpMlCTcLsNigd41tCsF"

payload = {}
files=[
  ('meta',('metadata.json',open('/path/metadata.json','rb'),'application/json')),
  ('file',('id-card-recto.png',open('/path/id-card-recto.png','rb'),'image/png')),
  ('file',('id-card-verso.png',open('/path/id-card-verso.png','rb'),'image/png'))
]
headers = {}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.json())

Réponse :

json
{
    "company": "comp_pQ2rLuQrMUwufhyqbzYXe58D",
    "files": [
        {
            "file-type": "image/png",
            "id": "dcmt_jXzQOAxmdSHwIyRgEEtepQ3y",
            "user-file-name": "id-card-recto.png"
        },
        {
            "file-type": "image/png",
            "id": "dcmt_WFKI7fNCtZYvvv16Ru52OYYH",
            "user-file-name": "id-card-verso.png"
        }
    ]
}

IBAN ​

Renseigner uniquement le fichier IBAN (relevé d'identité bancaire) :

Le fichier IBAN doit être au format PDF.

python
import requests

url = "https://api-partners.stancer.com/api/partners/document/7JQnjfKHDnfsr0MRwEAcddB3glWj7q"

payload = {}
files=[
  ('file',('iban-doc.pdf',open('/path/iban-doc.pdf','rb'),'application/pdf'))
]
headers = {}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.json())

Réponse :

json
{
    "company": "comp_pQ2rLuQrMUwufhyqbzYXe58D",
    "files": [
        {
            "file-type": "application/pdf",
            "id": "dcmt_THRJgNTKDqjHxzQotqD6Mey1",
            "user-file-name": "iban-doc.pdf"
        }
    ]
}

KBIS ​

Renseigner uniquement le fichier KBIS :

python
import requests

url = "https://api-partners.stancer.com/api/partners/document/HdgTAvnducNbK7PqJPw7se5kqx3Yrw"

payload = {}
files=[
  ('file',('kbis-doc.png',open('/path/kbis-doc.png','rb'),'image/png'))
]
headers = {}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.json())

Réponse :

json
{
    "company": "comp_pQ2rLuQrMUwufhyqbzYXe58D",
    "files": [
        {
            "file-type": "image/png",
            "id": "dcmt_XDIRRHbKzLGYTU7nJqKPzbkc",
            "user-file-name": "kbis-doc.png"
        }
    ]
}

Accès au document ​

Vous avez accès aux informations des documents envoyés via un GET /company?id=<comp> :

json
{
    "company": {
        ...
        "documents": [
            {
                "document-name": "iban-doc.pdf",
                "document-type": "iban",
                "iban": "FR1420041010050500013M02606",
                "id": "dcmt_THRJgNTKDqjHxzQotqD6Mey1"
            },
            {
                "date-birth": "2017-06-12",
                "document-name": "kbis-doc.png",
                "document-type": "kbis",
                "id": "dcmt_XDIRRHbKzLGYTU7nJqKPzbkc",
                "name": "iliad78",
                "number": "834315673"
            }
        ],
        ...
        "representatives": [
            {
                "documents": [
                    {
                        "address": "10 rue",
                        "city": "Paris",
                        "country": "fra",
                        "date-birth": "1991-01-28",
                        "date-expiry": "2025-12-01",
                        "date-issue": "2022-03-01",
                        "document-name": "id-card-recto.png",
                        "document-type": "idcard",
                        "id": "dcmt_jXzQOAxmdSHwIyRgEEtepQ3y",
                        "name": "Jean Dupont",
                        "number": "X4RTBPFW4",
                        "zip-code": "75008"
                    },
                    {
                        "address": "10 rue",
                        "city": "Paris",
                        "country": "fra",
                        "date-birth": "1991-01-28",
                        "date-expiry": "2025-12-01",
                        "date-issue": "2022-03-01",
                        "document-name": "id-card-verso.png",
                        "document-type": "idcard",
                        "id": "dcmt_WFKI7fNCtZYvvv16Ru52OYYH",
                        "name": "Jean Dupont",
                        "number": "X4RTBPFW4",
                        "zip-code": "75008"
                    }
                ],
                "person": {
                    ...
                    "first-name": "Jean",
                    "id": "pers_ixk24J12a8xEk4IirtGb3HQn",
                    "last-name": "Dupont",
                    ...
                },
                ...
            }
        ],
        ...
    },
    ...
}

Une fois l'inscription finalisée, l'IBAN sera renvoyé masqué: XXXXXXXXXXXXXXXXXXXXXXXXXXX.

Vous pouvez récupérer le fichier via un GET /document?company=<comp>&document=<dcmt>.

Une fois l'inscription finalisée, il n'est plus possible de récupérer le fichier.

python
import requests

url = "https://api-partners.stancer.com/api/partners/document?company=comp_pQ2rLuQrMUwufhyqbzYXe58D&document=dcmt_WFKI7fNCtZYvvv16Ru52OYYH"

payload = {}
headers = {}

requests.request("GET", url, headers=headers, data=payload)

Remplacer un document pour une société ​

Chaque document attendu à un upload-url défini que vous pouvez utiliser pour remplacer un document.

Vous pouvez accéder à cet upload-url via un GET /document-upload-url?company=<comp> et effectuer un PATCH /upload-url.

Supprimer le document d'une société ​

Utiliser l'endpoint DELETE /document?company=<comp>&document=<dcmt>&document-owner-type=<type>&head-id=<pers> pour supprimer le document d'une société :

document-owner-type :

  • company : pour supprimer un document de la société (IBAN, ...)
  • representative : pour supprimer le document d'identité d'un représentant
  • owner : pour supprimer le document d'identité d'un bénéficiaire

head-id (Optionnel) : renseignez-le lorsqu'il s'agit d'un document d'un représentant ou bénéficiaire.

Pour supprimer une carte d'identité vous pouvez renseigner uniquement l'un des dcmt du recto ou verso et les deux documents seront supprimés.

python
import requests

url = "https://api-partners.stancer.com/api/partners/document?company=comp_pQ2rLuQrMUwufhyqbzYXe58D&document=dcmt_jXzQOAxmdSHwIyRgEEtepQ3y&document-owner-type=representative&head-id=pers_ixk24J12a8xEk4IirtGb3HQn"

payload = {}
headers = {}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.json())