Endpoints sellers on boarding

PreviousMarketplace Services API NextEndpoints orders management

Last updated 1 month ago

Was this helpful?

Request a KYC assessment after completing the seller's data, contacts, and related documents.

post

The KYC assessments is only allowed when the onboardingProcessStatus is TASKS_COMPLETED that can happen in the following cases:

If the seller's dataStatus and documentListStatus, as well as those of all its contacts are COMPLETE.
If at least one of the seller's dataStatus or documentListStatus or that of its contacts, is COMPLETE and the others are VALIDATED.

Authorizations

Path parameters

merchantSellerIdstring · max: 55required

Unique identifier of the seller as defined by the merchant (Marketplace)
It must match this pattern: ^[a-zA-Z0-9_\-.]{3,55}$

Example: 1234-azerty-56789

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{merchantSellerId}/_assess-kyc'

202

400

401

403

404

409

500

{}

Accepted. You will receive the result through webhook.

Delete a contact and its related documents.

delete

Delete a contact and its related documents. It is not possible to delete a contact when the dataStatus is in "PENDING_VALIDATION" or "VALIDATED"

Authorizations

Path parameters

merchantSellerIdstring · max: 55required

Unique identifier of the seller as defined by the merchant (Marketplace)
It must match this pattern: ^[a-zA-Z0-9_\-.]{3,55}$

Example: 1234-azerty-56789

contactIdstring · uuidrequired

Unique technical identifier of the contact

Example: efbc8080-3ee3-4d07-8a95-994614391e4e

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{merchantSellerId}/contacts/{contactId}'

204

400

401

403

404

409

500

{}

The specific contact is deleted.

Delete the seller's document by specifying its unique ID.

delete

Delete the seller's document by specifying its unique ID.
It is not possible to delete the seller's document when the document status is "PENDING_VALIDATION" or "VALIDATED".

Authorizations

Path parameters

merchantSellerIdstring · max: 55required

Unique identifier of the seller as defined by the merchant (Marketplace)
It must match this pattern: ^[a-zA-Z0-9_\-.]{3,55}$

Example: 1234-azerty-56789

documentIdstring · uuidrequired

Document unique identifier

Example: bdf8080-3ee3-4d07-8a95-774614391e0e

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{merchantSellerId}/documents/{documentId}'

204

400

401

403

404

409

500

{}

The specific document is successfully deleted.

Delete the contact's document by specifying its unique ID.

delete

Delete the contact's document by specifying its unique ID.
It is not possible to delete the contact's document when its status (documentListStatus and dataStatus) are in "PENDING_VALIDATION" or "VALIDATED".

Authorizations

Path parameters

merchantSellerIdstring · max: 55required

Unique identifier of the seller as defined by the merchant (Marketplace)
It must match this pattern: ^[a-zA-Z0-9_\-.]{3,55}$

Example: 1234-azerty-56789

contactIdstring · uuidrequired

Unique technical identifier of the contact

Example: efbc8080-3ee3-4d07-8a95-994614391e4e

documentIdstring · uuidrequired

Document unique identifier

Example: bdf8080-3ee3-4d07-8a95-774614391e0e

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{merchantSellerId}/contacts/{contactId}/documents/{documentId}'

204

400

401

403

404

409

500

{}

The specific contact is deleted.

Retrieve a specific seller of the given marketplace using the unique identifier "merchantSellerId".

get

Use the unique identifier "merchantSellerId" (unique identifier of the seller on the marketplace), as a search criteria to find a specific seller.
The response represents the seller data, the list of documents owned by the seller, the list of its related contacts and the evaluation result (completness and KYC assessment) of the data and documents.
It is possible to get the seller at any step of the onboarding process.

Authorizations

Path parameters

merchantSellerIdstring · max: 55required

Unique identifier of the seller as defined by the merchant (Marketplace)
It must match this pattern: ^[a-zA-Z0-9_\-.]{3,55}$

Example: 1234-azerty-56789

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{merchantSellerId}'

200

400

401

403

404

500

GET Seller response after receiving the MP_KYC_VALIDATED event

GET Seller response after receiving the MP_IBAN_AVAILABLE_FOR_PAYMENT event

GET Seller response after receiving the MP_KYC_IN_PROGRESS event COMPLETE

GET Seller response after receiving the MP_KYC_REFUSED event

GET Seller response after KYC_assessment and before receiving MP_IBAN_AVAILABLE_FOR_PAYMENT event

GET Seller response when the OnboardingProcessStatus=TASKS_COMPLETED

GET Seller response when OnboardingProcessStatus=STARTED because the seller's documentListStatus is INCOMPLETE

GET Seller response when a technical error occurred after a KYC assessment

{
  "sellerId": 987456,
  "merchantSellerId": "1234-azerty-56789",
  "solutionCode": "MPFRGE-S1YP",
  "legalEntityName": "Amazon France",
  "address": {
    "streetNumber": "4",
    "streetName": "Roger Salengro",
    "zipCode": "59000",
    "cityName": "LILLE",
    "countryCode": "FR"
  },
  "email": "contact@seller.com",
  "phoneNumber": "+33666512877",
  "legalFormAcronym": "SARL",
  "legalEntityCapitalizationAmount": 10000,
  "legalEntityCapitalizationCurrency": "EUR",
  "businessActivity": {
    "typeCode": "NAF",
    "code": "01.11Z"
  },
  "externalRegistrations": [
    {
      "code": "SIRET",
      "value": "12345678900012",
      "date": "2017-07-21"
    },
    {
      "code": "VAT",
      "value": "FR12345678901"
    }
  ],
  "legalNumberOfEmployeeRange": "BETWEEN_1_AND_9",
  "legalNetIncomeRange": "BETWEEN_0_AND_4",
  "legalAnnualTurnover": "BETWEEN_0_AND_39",
  "bankingInformation": {
    "accountName": "Societe Generale compte principal",
    "iban": "FR1420041010050500013M02606",
    "bic": "SOGEFRTT",
    "currency": "EUR"
  },
  "lastUpdateDateTime": "2024-07-28T22:25:51.000Z",
  "documents": [
    {
      "id": "bdf8080-3ee3-4d07-8a95-774614391e0e",
      "name": "id_recto_verso_company_registration.pdf",
      "type": "COMPANY_REGISTRATION",
      "status": "VALIDATED"
    }
  ],
  "contacts": [
    {
      "id": "bdf8080-3ee3-4d07-8a95-774614391e0e",
      "firstName": "John",
      "lastName": "Snow",
      "email": "loan.Kee@seller.com",
      "phoneNumber": "+33666512877",
      "involvement": {
        "type": "SHAREHOLDER",
        "startDateTime": "2024-01-12T23:20:50.000Z"
      },
      "occupationType": "EMPLOYEE_IN_THE_PRIVATE_SECTOR",
      "personalAssets": "BETWEEN_0_AND_15",
      "address": {
        "streetNumber": "4",
        "streetName": "Roger Salengro",
        "zipCode": "75000",
        "cityName": "Paris",
        "countryCode": "FR"
      },
      "effectiveBeneficiary": 25,
      "commonTitle": "MR",
      "birthDate": "2000-09-09",
      "birthCityName": "Lille",
      "birthCountryCode": "FR",
      "nationality": "FR",
      "incomeRange": "BETWEEN_0_AND_999",
      "taxResidenceCountryCode": "FR",
      "taxResidenceTaxPayerId": "123456abc",
      "documents": [
        {
          "id": "bdf8080-3ee3-4d07-8a95-774614391e0e",
          "name": "id_recto_verso_passport.pdf",
          "type": "IDENTITY_CARD",
          "status": "VALIDATED"
        }
      ],
      "dataStatus": "VALIDATED",
      "documentListStatus": "VALIDATED"
    }
  ],
  "dataStatus": "VALIDATED",
  "documentListStatus": "VALIDATED",
  "onboardingProcessStatus": "KYC_OK",
  "identityVerification": {
    "type": "VIRTUAL_IBAN",
    "iban": "FR1420041010050500013M02606",
    "bic": "SOGEFRPPXXX"
  }
}

The seller's data and associated sub-resources that are registered during the onboarding process

Create a new contact for the given seller.

post

Create a new contact for the given seller.

Authorizations

Path parameters

merchantSellerIdstring · max: 55required

Unique identifier of the seller as defined by the merchant (Marketplace)
It must match this pattern: ^[a-zA-Z0-9_\-.]{3,55}$

Example: 1234-azerty-56789

Body

firstNamestring · max: 50required

Contact's first name. It must match the following pattern ^[a-zA-ZàáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ð ,.'-]+$

Example: John

lastNamestring · max: 50required

Contact's last name. Contact's first name. It must match the following pattern ^[a-zA-ZàáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ð ,.'-]+$

Example: Snow

emailstring · min: 6 · max: 320required

Email address
Email MUST match the format: ^((?:[a-z0-9_.+-]){1,64})(@)((?:[a-z0-9.\-])*(?:[a-z0-9])\.(?:[a-z0-9]){2,})$

Example: contact@seller.com

phoneNumberstring · min: 3 · max: 16optional

Phone number with international calling code.
It must match the format of the E.164 standard ^\+[1-9]\d{1,14}$

Example: +33666512877

involvementobjectoptional

Contact involvement in the seller's organization.

occupationTypestring · enumoptional

Type of occupation of the contact

Example: EMPLOYEE_IN_THE_PRIVATE_SECTOR

Available options:

personalAssetsstring · enumoptional

User's personal assets range exprimed in K€:

NONE: None
BETWEEN_0_AND_15: 0 to 15 000 euros
BETWEEN_15_AND_50: From 15 001 euros to 50 000 euros.
BETWEEN_50_AND_150: From 50 001 euros to 150 000 euros.
BETWEEN_150_AND_350: From 150 001 euros to 350 000 euros
BETWEEN_350_AND_750: From 350 001 euros to 750 000 euros.
BETWEEN_750_AND_1500: From 750 001 euros to 1 500 000 euros.
MORE_THAN_1500: Greater than 1 500 000 euros.

Example: BETWEEN_0_AND_15

Available options:

addressobjectoptional

Work address of the contact

effectiveBeneficiarynumber · floatoptional

percentage of ownership, if applicable (25.00 for 25%, 100.00 for 100%, etc.)

Example: 25

commonTitlestring · enumoptional

CivilityEnum of the physical person

Example: MR

Available options:

birthDatestringoptional

Date of birth in the format YYYY-MM-DD.

Example: 2000-09-09

birthCityNamestring · max: 50optional

City of birth

Example: San Francisco

birthCountryCodestring · max: 2optional

Country code (Format ISO 3166-1 alpha-2), must match this pattern '[A-Z][A-Z]'

Example: FR

nationalitystring · max: 2optional

Country code (Format ISO 3166-1 alpha-2), must match this pattern '[A-Z][A-Z]'

Example: FR

incomeRangestring · enumoptional

Monthly income range in EURO:

BETWEEN_0_AND_999 : 0 - 999 euros per month
BETWEEN_1000_AND_1800: 1000 - 1800 euros per month
BETWEEN_1801_AND_3500: 1801 - 3500 euros per month
BETWEEN_3501_AND_5000: 3501 - 5000 euros per month
BETWEEN_5001_AND_6500: 5001 - 6500 euros per month
BETWEEN_6501_AND_10000: 6501 - 10000 euros per month
MORE_THAN_10000: Greater than 10 000 euros per month

Example: BETWEEN_O_AND_999

Available options:

taxResidenceCountryCodestring · max: 2optional

Country code (Format ISO 3166-1 alpha-2), must match this pattern '[A-Z][A-Z]'

Example: FR

taxResidenceTaxPayerIdstring · max: 50optional

If taxResidenceCountryCode is not FR, specify the taxPayerId of the provided taxResidenceCountry

Example: 123456abc

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{merchantSellerId}/contacts' \
  --header 'Content-Type: application/json' \
  --data '{
    "firstName": "John",
    "lastName": "Snow",
    "email": "contact@seller.com",
    "phoneNumber": "+33666512877",
    "involvement": {
      "type": "SHAREHOLDER",
      "startDateTime": "2024-01-12T23:20:50.000Z"
    },
    "occupationType": "EMPLOYEE_IN_THE_PRIVATE_SECTOR",
    "personalAssets": "BETWEEN_0_AND_15",
    "address": {
      "streetNumber": "4",
      "streetName": "Roger Salengro",
      "zipCode": "59000",
      "cityName": "LILLE",
      "countryCode": "FR"
    },
    "effectiveBeneficiary": 25,
    "commonTitle": "MR",
    "birthDate": "2000-09-09",
    "birthCityName": "San Francisco",
    "birthCountryCode": "FR",
    "nationality": "FR",
    "incomeRange": "BETWEEN_O_AND_999",
    "taxResidenceCountryCode": "FR",
    "taxResidenceTaxPayerId": "123456abc"
  }'

201

400

401

403

404

409

500

{
  "contactId": "efbc8080-3ee3-4d07-8a95-994614391e4e",
  "dataStatus": "INCOMPLETE",
  "missingData": [
    "phoneNumber",
    "involvement",
    "involvement.type",
    "involvement.startDateTime",
    "occupationType",
    "personalAssets",
    "address",
    "address.streetNumber",
    "address.streetName",
    "address.zipCode",
    "address.cityName",
    "address.countryCode",
    "effectiveBeneficiary",
    "commonTitle",
    "birthDate",
    "birthCityName",
    "birthCountryCode",
    "nationality",
    "incomeRange",
    "taxResidenceCountryCode",
    "taxResidenceTaxPayerId"
  ]
}

Contact is successfully created.

Update a part or an entire resource of a contact

patch

Update a part or the entire resource of a contact.
The three fields: firstName, lastName, email could not be updated with a null value.
Fields not included in the request should stay unmodified.
When a field is explicitely set to null, its value will be nullified in database.
This endpoint could be used to fill in a contact's missing data to get a dataStatus equal to COMPLETE.
The update of the contact resource is allowed when the dataStatus is COMPLETE or INCOMPLETE

Authorizations

Path parameters

merchantSellerIdstring · max: 55required

Unique identifier of the seller as defined by the merchant (Marketplace)
It must match this pattern: ^[a-zA-Z0-9_\-.]{3,55}$

Example: 1234-azerty-56789

contactIdstring · uuidrequired

Unique technical identifier of the contact

Example: efbc8080-3ee3-4d07-8a95-994614391e4e

Body

firstNamestring · max: 50optional

Example: John

lastNamestring · max: 50optional

Example: Snow

emailstringoptional

Email address
Email MUST match the format: ^((?:[a-z0-9_.+-]){1,64})(@)((?:[a-z0-9.\-])*(?:[a-z0-9])\.(?:[a-z0-9]){2,})$

Example: contact@seller.com

phoneNumberstringoptional

Phone number with international calling code.
It must match the format of the E.164 standard ^\+[1-9]\d{1,14}$

Example: +33666512877

involvementobjectoptional

Contact involvement in the seller's organization.

occupationTypestring · enumoptional

Type of occupation of the contact

Example: EMPLOYEE_IN_THE_PRIVATE_SECTOR

Available options:

personalAssetsstring · enumoptional

User's personal assets range exprimed in K€:

NONE: None
BETWEEN_0_AND_15: 0 to 15 000 euros
BETWEEN_15_AND_50: From 15 001 euros to 50 000 euros.
BETWEEN_50_AND_150: From 50 001 euros to 150 000 euros.
BETWEEN_150_AND_350: From 150 001 euros to 350 000 euros
BETWEEN_350_AND_750: From 350 001 euros to 750 000 euros.
BETWEEN_750_AND_1500: From 750 001 euros to 1 500 000 euros.
MORE_THAN_1500: Greater than 1 500 000 euros.

Example: BETWEEN_0_AND_15

Available options:

addressobjectoptional

Work address of the contact

effectiveBeneficiarynumber · floatoptional

percentage of ownership, if applicable (25.00 for 25%, 100.00 for 100%, etc.)

Example: 25

commonTitlestring · enumoptional

CivilityEnum of the physical person

Example: MR

Available options:

birthDatestringoptional

Date of birth in the format YYYY-MM-DD.

Example: 2000-09-09

birthCityNamestring · max: 50optional

City of birth

Example: San Francisco

birthCountryCodestring · max: 2optional

Country code (Format ISO 3166-1 alpha-2), must match this pattern '[A-Z][A-Z]'

Example: FR

nationalitystring · max: 2optional

Country code (Format ISO 3166-1 alpha-2), must match this pattern '[A-Z][A-Z]'

Example: FR

incomeRangestring · enumoptional

Monthly income range in EURO:

BETWEEN_0_AND_999 : 0 - 999 euros per month
BETWEEN_1000_AND_1800: 1000 - 1800 euros per month
BETWEEN_1801_AND_3500: 1801 - 3500 euros per month
BETWEEN_3501_AND_5000: 3501 - 5000 euros per month
BETWEEN_5001_AND_6500: 5001 - 6500 euros per month
BETWEEN_6501_AND_10000: 6501 - 10000 euros per month
MORE_THAN_10000: Greater than 10 000 euros per month

Example: BETWEEN_0_AND_999

Available options:

taxResidenceCountryCodestring · max: 2optional

Country code (Format ISO 3166-1 alpha-2), must match this pattern '[A-Z][A-Z]'

Example: FR

taxResidenceTaxPayerIdstring · max: 50optional

If taxResidenceCountryCode is not FR, specify the taxPayerId of the provided taxResidenceCountry

Example: 123456abc

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{merchantSellerId}/contacts/{contactId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "firstName": "John",
    "lastName": "Snow",
    "email": "contact@seller.com",
    "phoneNumber": "+33666512877",
    "involvement": {
      "type": "SHAREHOLDER",
      "startDateTime": "2024-01-12T23:20:50.000Z"
    },
    "occupationType": "EMPLOYEE_IN_THE_PRIVATE_SECTOR",
    "personalAssets": "BETWEEN_0_AND_15",
    "address": {
      "streetNumber": "4",
      "streetName": "Roger Salengro",
      "zipCode": "59000",
      "cityName": "LILLE",
      "countryCode": "FR"
    },
    "effectiveBeneficiary": 25,
    "commonTitle": "MR",
    "birthDate": "2000-09-09",
    "birthCityName": "San Francisco",
    "birthCountryCode": "FR",
    "nationality": "FR",
    "incomeRange": "BETWEEN_0_AND_999",
    "taxResidenceCountryCode": "FR",
    "taxResidenceTaxPayerId": "123456abc"
  }'

200

400

401

403

404

409

500

{
  "dataStatus": "INCOMPLETE",
  "missingData": [
    "phoneNumber",
    "involvement",
    "involvement.type",
    "involvement.startDateTime",
    "occupationType",
    "personalAssets",
    "address",
    "address.streetNumber",
    "address.streetName",
    "address.zipCode",
    "address.cityName",
    "address.countryCode",
    "effectiveBeneficiary",
    "commonTitle",
    "birthDate",
    "birthCityName",
    "birthCountryCode",
    "nationality",
    "incomeRange",
    "taxResidenceCountryCode",
    "taxResidenceTaxPayerId"
  ]
}

Contact is successfully updated.

Register a new document for the given seller.

post

Register a new document for the given seller.
Register a new document consisting of metadata and a file content that must be encoded in base64.
The document type "COMPANY_REGISTRATION" is required to achieve the status COMPLETE about the completness of the document list of a seller, the other document types are optional.

Authorizations

Path parameters

merchantSellerIdstring · max: 55required

Unique identifier of the seller as defined by the merchant (Marketplace)
It must match this pattern: ^[a-zA-Z0-9_\-.]{3,55}$

Example: 1234-azerty-56789

Body

namestring · max: 90required

Original name of the uploaded file.
The document name MUST match the following pattern: ^[^<>:;,?"\*|/$]+.[A-Za-z]{3,}+$
The document name MUST end with an extension that represents its media format.
The extensions MUST match the following case-insensitive values pdf, jpeg, jpg, png.

Example: id_recto_verso_company_registration.pdf

fileContentstring · byterequired

Content of the file object, base64 encoded characters. The max size of the file must not exceed 4 MO.

Example: U3dhZ2dlciByb2Nrcw==

typestring · enumrequired

Type of the document.

Example: COMPANY_REGISTRATION

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{merchantSellerId}/documents' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "id_recto_verso_company_registration.pdf",
    "fileContent": "U3dhZ2dlciByb2Nrcw==",
    "type": "COMPANY_REGISTRATION"
  }'

201

400

401

403

404

409

500

{
  "documentId": "0bdf8080-3ee3-4d07-8a95-774614391e0e",
  "documentListStatus": "COMPLETE"
}

Document is successfully created

Register a new document for the given contact.

post

Register a new document for the given seller.
Register a new document consisting of metadata and a file content that must be encoded in base64.
At least one document of type "PASSPORT" or "IDENTITY_CARD" is required to reach status COMPLETE regarding the completeness of a contact's document list, other document types are optional

Authorizations

Path parameters

merchantSellerIdstring · max: 55required

Unique identifier of the seller as defined by the merchant (Marketplace)
It must match this pattern: ^[a-zA-Z0-9_\-.]{3,55}$

Example: 1234-azerty-56789

contactIdstring · uuidrequired

Unique technical identifier of the contact

Example: efbc8080-3ee3-4d07-8a95-994614391e4e

Body

namestring · max: 90required

Original name of the uploaded file.
The document name MUST match the following pattern: ^[^<>:;,?"\*|/$]+.[A-Za-z]{3,}+$
The document name MUST end with an extension that represents its media format.
The extensions MUST match the following case-insensitive values pdf, jpeg, jpg, png.

Example: id_recto_verso_company_registration.pdf

fileContentstring · byterequired

Content of the file object, base64 encoded characters. The max size of the file must not exceed 4 MO.

Example: U3dhZ2dlciByb2Nrcw==

typestring · enumrequired

Type of the document.

Example: IDENTITY_CARD

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{merchantSellerId}/contacts/{contactId}/documents' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "id_recto_verso_company_registration.pdf",
    "fileContent": "U3dhZ2dlciByb2Nrcw==",
    "type": "IDENTITY_CARD"
  }'

201

400

401

403

404

409

500

{
  "documentId": "0bdf8080-3ee3-4d07-8a95-774614391e0e",
  "documentListStatus": "COMPLETE"
}

The document for Kyc has been well added

Create or replace a Seller.

put

Create a new seller if it does not exist otherwise replace it.
The seller is identified by the seller's identifier as defined by the marketplace.
Update the entire resource of a seller.
The update of the seller is allowed only when its dataStatus is COMPLETE or INCOMPLETE.

Authorizations

Path parameters

merchantSellerIdstring · max: 55required

Unique identifier of the seller as defined by the merchant (Marketplace)
It must match this pattern: ^[a-zA-Z0-9_\-.]{3,55}$

Example: 1234-azerty-56789

Body

solutionCodestring · max: 11required

Scalexpert product identifier for marketplace services.
The given solutionCode must already be subscribed to by the marketplace.
solutionCode must match this format ^MP\w{4}-\w{4}$
Refer to the reference documentation for the marketPlace solution codes.

Example: MPFRGE-S1YP

legalEntityNamestring · max: 40required

Legal entity name of the seller.

Example: Amazon France

addressobjectrequired

Work address of the contact

emailstring · min: 6 · max: 320optional

Email address
Email MUST match the format: ^((?:[a-z0-9_.+-]){1,64})(@)((?:[a-z0-9.\-])*(?:[a-z0-9])\.(?:[a-z0-9]){2,})$

Example: contact@seller.com

phoneNumberstring · min: 3 · max: 16optional

Phone number with international calling code.
It must match the format of the E.164 standard ^\+[1-9]\d{1,14}$

Example: +33666512877

legalFormAcronymstring · enumoptional

The company form of the seller.

Example: SARL

Available options:

legalEntityCapitalizationAmountnumber · floatoptional

Legal entity capitalization amount in a main unit of the currency.

Example: 1000

legalEntityCapitalizationCurrencystring · iso-4217optional

3 letter currency code as defined by ISO-4217. It must match this pattern [A-Z][A-Z][A-Z]

Example: EUR

businessActivityobjectoptional

Business activity of the seller

externalRegistrationsobject[]optional

External registration list about the seller

legalNumberOfEmployeeRangestring · enumoptional

Business number of employees range

Example: BETWEEN_1_AND_9

Available options:

legalNetIncomeRangestring · enumoptional

Business annual net income range (in k€)

Example: BETWEEN_0_AND_4

Available options:

legalAnnualTurnoverstring · enumoptional

Business annual turnover (in k€)

Example: BETWEEN_100_AND_249

Available options:

bankingInformationobjectoptional

Banking information of the seller.

sanctionsQuestionnaireobjectoptional

Information that must be provided to verify whether the seller's entity is related to sanctioned matters

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.scalexpert.uatc.societegenerale.com/baas/uatc/marketplace/api/v1/sellers/{merchantSellerId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "solutionCode": "MPFRGE-S1YP",
    "legalEntityName": "Amazon France",
    "address": {
      "streetNumber": "4",
      "streetName": "Roger Salengro",
      "zipCode": "59000",
      "cityName": "LILLE",
      "countryCode": "FR"
    },
    "email": "contact@seller.com",
    "phoneNumber": "+33666512877",
    "legalFormAcronym": "SARL",
    "legalEntityCapitalizationAmount": 1000,
    "legalEntityCapitalizationCurrency": "EUR",
    "businessActivity": {
      "typeCode": "NAF",
      "code": "01.11Z"
    },
    "externalRegistrations": [
      {
        "code": "SIRET",
        "value": "362521879",
        "date": "2017-07-21"
      }
    ],
    "legalNumberOfEmployeeRange": "BETWEEN_1_AND_9",
    "legalNetIncomeRange": "BETWEEN_0_AND_4",
    "legalAnnualTurnover": "BETWEEN_100_AND_249",
    "bankingInformation": {
      "accountName": "Société Générale compte principal",
      "iban": "FR1420041010050500013M02606",
      "bic": "SOGEFRPPXX",
      "currency": "EUR"
    },
    "sanctionsQuestionnaire": {
      "entityType": "REPORTING_FINANCIAL_INSTITUTION",
      "activityOutsideEuScope": "ONLY_THE_LEGAL_ENTITY",
      "isActiveOutsideEu": true,
      "isSubjectToSanctions": true,
      "isLocatedInSanctionedCountry": true,
      "isEngagedWithSanctionedParty": true
    }
  }'

200

400

401

403

404

409

500

DataStatus COMPLETE

If dataStatus is INCOMPLETE in case the address.countryCode=FR

If dataStatus is INCOMPLETE in case the address.countryCode is different from FR

{
  "dataStatus": "COMPLETE",
  "missingData": []
}

Seller is successfully registered or updated.

Endpoints sellers on boarding

Endpoints sellers on boarding

Sellers On boarding

Contacts

Documents

Sellers

Sellers On boarding

Contacts

Documents

Sellers

Request a KYC assessment after completing the seller's data, contacts, and related documents.

Delete a contact and its related documents.

Delete the seller's document by specifying its unique ID.

Delete the contact's document by specifying its unique ID.

Retrieve a specific seller of the given marketplace using the unique identifier "merchantSellerId".

Create a new contact for the given seller.

Update a part or an entire resource of a contact

Register a new document for the given seller.

Register a new document for the given contact.

Create or replace a Seller.

Sellers On boarding

Contacts

Documents

Sellers

Sellers On boarding

Contacts

Documents

Sellers

Request a KYC assessment after completing the seller's data, contacts, and related documents.

Delete a contact and its related documents.

Delete the seller's document by specifying its unique ID.

Delete the contact's document by specifying its unique ID.

Retrieve a specific seller of the given marketplace using the unique identifier "merchantSellerId".

Create a new contact for the given seller.

Show child attributes

Show child attributes

Update a part or an entire resource of a contact

Show child attributes

Show child attributes

Register a new document for the given seller.

Register a new document for the given contact.

Create or replace a Seller.

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes