Upload a Kyc diligence

post

https://sb-api.xpollens.com/api/v2.0/users/{appUserId}/kyc/attachments

Description

This endpoint allows the partner to upload the documents for each diligence type.
The documents related to the identity proof can be uploaded as one or more files in the same request.
However, the documents related to the company must be uploaded as one document for each diligence type.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

appUserId

string

required

User identifier of partner

Format

Min 6 characters, max 30 characters

Accepted characters

0-9 a-z A-Z_-.!()

Example

ABCDEFGHI or
A1B2C3d4f5g678901234567890123

Body Params

type

string

required

length ≥ 1

Type of due diligence

Diligence sub type referential

Id	Code	Description
1	ID_CARD	Id card
2	PASSPORT	Passport
3	VETERAN_CARD	Veteran card
4	MILITARY_ID	Military id card
5	RES_CARD	Residence card
6	EMPL_CONTRACT	Employment contract
7	PAYSLIP	Last payslip
8	CESU	CESU
9	PENSION_RET	Pension retirement
10	STUDENT_ID	Student card - School certificate - Scolarship certificat
11	TAX_NOTICE	Tax notice
12	INCOME_TAX	Income tax receipt
13	ASDIR	ASDIR ( Assedic)
14	RSA	RSA
15	RMI	RMI
16	DIS_CERTIF	Disability certificate
17	PROOF_FAM_ALLOW	Proof of payment of family allowances
18	ACC_STAT	Account statement
19	SCTIN	Sepa Credit Transfer In
20	ACC_AGG	Account aggregation
21	SELFIE	Selfie
25	COMPANY_STATUTES	The signed statutes of the compagny
26	KBIS	Kbis
27	EXTRACT_D1	Extract D1
28	PREFECTURE_RECEIPT	Receipt form prefecture
29	RNSC_CERTIFICATE	RNSC certificate
30	ANAH_FORM	ANAH form
31	OTHER_EXISTENCE_PROOF	Other Existence Proof
32	INVOICE	Invoice
33	BALANCE_SHEET	Company balance sheet
34	TAX_REPORT	Tax report
35	OTHER_ECONOMIC_ACTIVITY_EVIDENCE	Other economic activity evidence
36	UBO_DECLARATION_FORM	Ultimate Beneficial Owners declaration form
37	OTHER_DELEGATION	Other delegation
40	GENERAL_ASSEMBLY_STATEMENT	General assembly statement
41	DIRECTORS_BOARD_STATEMENT	Director board statement
42	APPOINTMENT_DECREES	Appointment decrees
43	OFFICIAL_NEWSPAPER_EXTRACT	Offical newespaper extract
44	FINESS_NOTICE	Finess notice
45	BUSINESS_CARD	Business card
46	MSA_CERTIFICATE	MSA certificate
47	ORDER_CERTIFICATE	Order certificate
48	ENIM_CERTIFICATE	ENIM certificate
49	CONST_AGREEMENT	Convention Constitutive
50	DELEGATED_COMPLEMENTARY_DILIGENCE	Delegated complementary diligence
51	ESIGN	ELECTRONIC SIGN
52	UNDEFINED	Undefined
53	TIERCE_INTRODUCTION	Tierce introduction
54	OTHER	Other type of document
55	THIRDPARTY_INTRODUCTION_IDENTITY	Third party introduction Identity
56	THIRDPARTY_INTRODUCTION_COMPLEMENTARY	Third party introduction Complementary
57	SIREN_NOTICE	SIREN Status notice
58	ADELI_CERTIFICATE	RPPS directory status
59	PROFESSIONAL_ORDER_CERTIFICATE	Registration certificate of professional order
60	DRIVER_LICENSE	Driver license
61	POWER_MANDATE	Power and Mandate
62	INPI_CERTIFICATE	INPI certificate

files

array of objects

required

Attachment must be identity documents. Income proof are not yet managed.

files*

Headers

CorrId

string

Defaults to aecf5103-0679-49a0-91f2-8810787635de

Correlation Id

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

Description
The Name field is required.
The Type field is required.
The Content field is required.
Missing request Parameter(s)
The Files field is required.
Type must be in attachment type referential
The request to send a diligence other than identity, must not contain more than 1 document
The request to send an identity diligence must not contain more than 2 documents
Document type not allowed

Description
Demand does not exist.

Description
Unsupported Media Type

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

201Created

404 Not Found : DescriptionDemand does not exist.

415 Unsupported Media Type : DescriptionUnsupported Media Type

500Internal Server Error