S-money API

Send data to the third-party server

Hadassa — 2017-08-30T16:19:43Z

Send data to the third-party server

The third-party server has to make available a server url enabling the S-money server to notify it when a request item is validated or rejected. With every notification the status and the fonction of the user can evolve.

The call to the S-money server is made using the method HTTP POST with a content-type : application/json

The HTTP request parameters are:

Parameters	Type	Description
type	Int	Operation type 4 = KYC
parameters	parameters	Callback details

Parameters

Parameters	Type	Description
user	user	Object displaying user details
demand	demand	Object displaying details of the request associated with the user
attachments	[attachment]	Tab displaying the detail of one or several items

User

Parameter	Type	Description
id	long	Client S-money ID
appuserid	string	Client ID for the third-party application
status	int	1 = OK 2 = Frozen 3 = On the fly 4 = Closing 5 = Closed 6 = Waiting for KYC (transfers blocked) 7 = Blocked
role	int	1 = Client 2 = Extended client (KYC)

Demand

Parameter	Type	Description
id	long	KYC request ID
status	int	0 = Incomplete 1 = Pending 2 = Rejected 3 = Accepted
message	string	Reason entered by the operator

Attachment

Parameter	Type	Description
id	long	Item ID
status	int	0 = Pending 1 = Valid 2 = Invalid 3 = Incomplete 4 = Not verified 5 = In progress 7 = Ignored
type	int	0 = Bank account details 1 = ID 2 = Proof of adress 3 = KBIS 4 = Other
additionalStatus	int	0 = Not vérified 1 = Compliant, consistent and valid 2 = Falsified (if ID falsified or minor) 3 = Unreadable or cut 4 = Item missing or out of scope (If ID: Only Verso with missing back / if bank account details: Bank out of scope / if proof of adress: Provider out of scope) 5 = Not consistent / data (if ID: Name - surname are reversed / if proof of adress: error on the holder) 6 = Not consistent / data: other error 7 = Expired 8 = Compliant, consistent and valid but not qualifiable (If bank account details or proof of adress: verified except for name of the holder not verified) 9 = Out of scope (Not an ID, or not bank account details, or not a proof of adress)
message	string	Reason entered by the operator

Envoi des données au serveur Tiers

Hadassa — 2017-08-30T16:18:57Z

Envoi des données au serveur Tiers

Le serveur tiers doit mettre à disposition une url serveur permettant au serveur S-money de le notifier lors de la validation ou du refus d'une pièce de la demande. A chaque notification le statut et le rôle de l'utilisateur peut évoluer.

L'appel du serveur S-money est effectué en méthode HTTP POST avec un content-type : application/json

Les paramètres de la requête HTTP sont :

Paramètre	Type	Description
type	Int	Type de l'opération 4 = KYC
parameters	parameters	Détails du callback

Parameters

Paramètre	Type	Description
user	user	Objet présentant le détail de l'utilisateur
demand	demand	Objet présentant le détail de la demande associée à l'utilisateur
attachments	[attachment]	Tableau présentant le détail d'une ou plusieurs pièces

User

Paramètre	Type	Description
id	long	Id S-money du client
appuserid	string	Identifiant du client pour l'application tierce
status	int	1 = OK 2 = Gelé 3 = A la volée 4 = En cours de fermeture 5 = Fermé 6 = En attente de KYC (virements bloqués) 7 = En opposition
role	int	1 = Client 2 = Client étendu (KYC)

Demand

Paramètre	Type	Description
id	long	Id de la demande de KYC
status	int	0 = Incomplet 1 = En attente 2 = Refusé 3 = Accepté
message	string	Motif saisi par l'opérateur

Attachment

Paramètre	Type	Description
id	long	Id de la pièce
status	int	0 = En attente 1 = Valide 2 = Invalide 3 = Incomplet 4 = Non vérifié 5 = En cours 7 = Ignoré
type	int	0 = RIB 1 = Justificatif d'identité 2 = Justificatif de domicile 3 = KBIS 4 = Autre
additionalStatus	int	0 = Non vérifié 1 = Conforme, cohérent et valide 2 = Falsifiée (si carte d'identité falsifiée ou mineur) 3 = Illisible ou coupée 4 = Elément manquant ou hors périmètre (Si carte d'identité : Verso seul recto manquant / Si RIB : Banque hors périmètre / Si justificatif de domicile : Fournisseur hors périmètre) 5 = Non cohérent / données (Si carte d'identité : inversion nom - prénom / Si justificatif de domicile : erreur sur le titulaire) 6 = Non cohérent / donnée : autre erreur 7 = Expiré 8 = Conforme, cohérent et valide mais non labellisable (Si RIB ou Justificatif de domicile : Vérifié sauf prénom du titulaire non vérifié) 9 = Hors périmètre (pas un document d'identité ou pas un RIB ou pas un justificatif de domicile)
message	string	Motif saisi par l'opérateur

Retrieve an item

Hadassa — 2017-04-04T12:35:04Z

To retrieve an item associated with a client, please refer to the example in the right margin of this page.

Request :
GET /api/[domaine partenaire]/users/appuserid/attachments/id-de-la-piece HTTP/1.1
Accept: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

Response :
TTP/1.1 200 OK
Content-Type: application/vnd.s-money.v1+json

[
 {
 "Id": 25545,
 "Name": "Carte.jpg",
 "Type": 1,
 "ContentType": "image/png",
 "Size": 523010,
 "Status": 0,
 "Message": "Non vérifié",
 "AdditionalStatus": 0,
 "TreatmentDate": null,
 "ReceivedDate": "2017-05-22T09:54:26",
 "Href": "https://rest-pp.s-money.fr/api/[domaine partenaire]/users/appuserid/kyc/idDemande/attachments/idPiece"
 }]

Récupérer une pièce

Hadassa — 2017-04-04T12:34:19Z

Pour récupérer une pièce associé à un client, veuillez vous référer à l'exemple présent en marge de droite de cette page.

Requête :
GET /api/[domaine partenaire]/users/appuserid/attachments/id-de-la-piece HTTP/1.1
Accept : application/vnd.s-money.v1+json
Authorization : Bearer ACCESS_TOKEN

Réponse :
TTP/1.1 200 OK
Content-Type : application/vnd.s-money.v1+json

[
 {
 "Id": 25545,
 "Name": "Carte.jpg",
 "Type": 1,
 "ContentType": "image/png",
 "Size": 523010,
 "Status": 0,
 "Message": "Non vérifié",
 "AdditionalStatus": 0,
 "TreatmentDate": null,
 "ReceivedDate": "2017-05-22T09:54:26",
 "Href": "https://rest-pp.s-money.fr/api/[domaine partenaire]/users/appuserid/kyc/idDemande/attachments/idPiece"
 }]

Retrieve the list of items

Hadassa — 2017-04-04T12:29:47Z

To retrieve the list of items associated with a client, please refer to the example in the right margin of this page.

Requête :
GET /api/[domaine partenaire]/users/appuserid/attachments HTTP/1.1
Accept: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

Réponse :
HTTP/1.1 200 OK
Content-Type: application/vnd.s-money.v1+json

[
 {
 "Id": 25545,
 "Name": "Carte.jpg",
 "ContentType": "image/jpeg",
 "Size": 595284,
 "Status": null,
 "Message": "",
 "AdditionalStatus": null,
 "Href": "https://rest-pp.s-money.fr/api/[domaine partenaire]/users/appuserid/kyc/idDemande/attachments/idPiece"
 }, {…}]

Récupérer la liste des pièces

Hadassa — 2017-04-04T12:28:14Z

Pour récupérer la liste des pièces associées à un client, veuillez vous référer à l'exemple présent en marge de droite de cette page.

Requête :
GET /api/[domaine partenaire]/users/appuserid/attachments HTTP/1.1
Accept : application/vnd.s-money.v1+json
Authorization : Bearer ACCESS_TOKEN

Réponse :
HTTP/1.1 200 OK
Content-Type : application/vnd.s-money.v1+json

[
 {
 "Id": 25545,
 "Name": "Carte.jpg",
 "ContentType": "image/jpeg",
 "Size": 595284,
 "Status": null,
 "Message": "",
 "AdditionalStatus": null,
 "Href": "https://rest-pp.s-money.fr/api/[domaine partenaire]/users/appuserid/kyc/idDemande/attachments/idPiece"
 }, {…}]

Delete a piece

Hadassa — 2017-03-17T11:45:01Z

You can delete an item, as long as the KYC request has not been processed.

The first entry point to delete an item is:
DELETE /api/[domaine partenaire]/users/appuserid/attachments/idAttachment

The second entry point to delete an item is:
DELETE /api/[domaine partenaire]/users/appuserid/kyc/idDeLaDemande/attachments/idAttachment

To delete an item, please refer to the example in the right margin of this page.

Requête :
DELETE /api/[domaine partenaire]/users/appuserid/kyc/idDeLaDemande/attachments/idAttachment
OU
DELETE /api/[domaine partenaire]/users/appuserid/attachments/idAttachment
HTTP/1.1
Accept: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

Réponse :
HTTP/1.1 204 No Content

Supprimer une pièce

Hadassa — 2016-11-23T15:28:22Z

Il est possible de supprimer une pièce, tant que la demande de KYC n'est pas traitée.

Le premier point d'entrée pour supprimer une pièce est :
DELETE /api/[domaine partenaire]/users/appuserid/attachments/idAttachment

Le second point d'entrée pour supprimer une pièce est :
DELETE /api/[domaine partenaire]/users/appuserid/kyc/idDeLaDemande/attachments/idAttachment

Pour supprimer une pièce, veuillez vous référer à l'exemple en marge de droite de cette page.

Requête :
DELETE /api/[domaine partenaire]/users/appuserid/kyc/idDeLaDemande/attachments/idAttachment
OU
DELETE /api/[domaine partenaire]/users/appuserid/attachments/idAttachment

HTTP/1.1
Accept : application/vnd.s-money.v1+json
Authorization : Bearer ACCESS_TOKEN

Réponse :
HTTP/1.1 204 No Content

Retrieve the KYC request

Hadassa — 2016-07-05T16:21:32Z

To retrieve the KYC request, please have a look at the example in the right margin of this page.

Requête :
GET /api/[domaine partenaire]/users/appuserid/kyc/ HTTP/1.1
Accept: application/vnd.s-money.v1+json
Authorization: Bearer ACCESS_TOKEN

Réponse :
TTP/1.1 200 OK
Content-Type: application/vnd.s-money.v1+json

[{
 "id":18,
 "requestdate":"2013-11-29T00:00:00",
 "status":1,
 "reason":null,
 "vouchercopies":[{
 "id":23339
 "name":"carte d'identité",
 "type" :1,
 "ContentType":"image/png",
 "size":523010,
 "Status":0
 "Message":"Non vérifié"
 "AdditionnalStatus":0,
 "TreatmentDate": null,
 "ReceivedDate" : "2017-05-22T09:54:26",
 "href":"/api/kyc/attachments/{id}"
 }, {…}] 

{…}]

Create a KYC request

Hadassa — 2016-07-05T16:17:30Z

To create a KYC request via the API, please refer to the example in the right margin of this page.

3 entry point are available according to the type of document sent:

POST /users/appuserid/kyc/identitycontrol to send an ID (only usable for private individuals)

POST /users/appuserid/kyc/addresscontrol to send a proof of adress (only usable for private individuals)

POST /users/appuserid/kyc to send any other supporting document

Sending the first item opens the request, then the next sendings will contribute to the request.
Warning: the name of the file sent must not exceed 100 caracters. The maximum size allowed in the request is 20 MB, the size per piece is 10 MB.

Validation of rejection of a KYC request

Verifying KYC requests takes a few seconds when using /idcontrol or /addresscontrol.
Please note that front and back sides of ID need to be sent in the same request in two different files. In addition, for the tests, proofs of adress and ID need to be real to be validated.

S-money verifies KYC requests within 48h. When the request is being processed, a notification is sent to the third-party server.

Requête :
POST /api/[domaine partenaire]/users/appuserid/kyc/ HTTP/1.1
Accept: application/vnd.s-money.v1+json
Content-Type: multipart/form-data; boundary=-------------------------acebdf13572468
Authorization: Bearer ACCESS_TOKEN
---------------------------acebdf13572468
Content-Disposition: form-data; name="file1"; filename="img1.png"
Content-Type: image/png
[FILE CONTENT]
---------------------------acebdf13572468
Content-Disposition: form-data; name="file2"; filename="img2.png"
Content-Type: image/png
[FILE CONTENT]
---------------------------acebdf13572468
Content-Disposition: form-data; name="file3"; filename="img3.png"
Content-Type: image/png
[FILE CONTENT]
---------------------------acebdf13572468—

Réponse :
HTTP/1.1 201 CREATED
Content-Type: application/vnd.s-money.v1+json
Location: /api/[domaine partenaire]/users/appuserid/kyc/18

[{
 "id":18,
 "requestdate":"2013-11-29T00:00:00",
 "status":1,
 "vouchercopies":[{
 "id":23339
 "name":"carte d'identité",
 "type":1,
 "ContentType":"image/png",
 "size":523010,
 "Status":0
 "Message":"Non vérifié"
 "AdditionnalStatus":0,
 "TreatmentDate": null,
 "ReceivedDate": "2017-05-22T09:54:26",
 "href":"/api/kyc/attachments/{id}"
 }, {…}]