Required Documents

NOTE

If you are a non-IOBSP partner, you do not need to submit any documents.

Retrieve the list of required documents

Use the endpoint GET /document-upload-url?company=<comp> to retrieve the list of required documents for a company:

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())

Response:

{
    "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"
      }
    ]
}

You can also access the documents-to-upload object after a GET|PATCH|POST /company request.

Send a POST or PATCH request to the upload-url to add or replace a document.

Add a document for a company

Each document is expected at a defined upload-url that you can use to add a document.

You can access this upload-url via a GET /document-upload-url?company=<comp> and perform a POST /upload-url.

Identification Documents (optional)

Providing identification documents is optional; users can enter this information when finalizing their registration.

For identity documents, you must provide a JSON meta file containing the following information:

• date-expiry: document expiration date
• date-issue: document issuance date
• number: document number

{
  "date-expiry": "2025-12-01",
  "date-issue": "2022-03-01",
  "number": "X4RTBPFW4"
}

To upload an ID card, you must submit the front and back of the document:

NOTE

If the representative and the beneficiary are the same person, the document is automatically assigned to the representative.

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())

Response:

{
    "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

Please submit only the IBAN file (bank identification details):

The IBAN file must be in PDF format.

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())

Response:

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

KBIS

Enter only the KBIS file:

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 :

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

Accessing the document

You can access the information in the documents sent via a GET /company?id=<comp> request:

{
    "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",
                    ...
                },
                ...
            }
        ],
        ...
    },
    ...
}

Once registration is complete, the IBAN will be returned masked as: XXXXXXXXXXXXXXXXXXXXXXXXXXX.

You can retrieve the file using a GET /document?company=<comp>&document=<dcmt>.

Once registration is complete, you will no longer be able to retrieve the file.

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)

Replacing a document for a company

Each document has a defined upload-url that you can use to replace a document.

You can access this upload-url via a GET /document-upload-url?company=<comp> request and perform a PATCH /upload-url request.

Delete a document from a company

Use the endpoint DELETE /document?company=<comp>&document=<dcmt> to delete a document from a company:

import requests

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

payload = {}
headers = {}

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

print(response.json())