API completa i documenti

Questo endpoint serve a completare la richiesta aggiungendo ulteriori dati del cliente scritti nei propri documenti personali.

Endpoint

				
					Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/requests/{fiscalCode}
Produzione: https://api.soisy.it/api/shops/{shopId}/requests/{fiscalCode}
				
			
				
					PATCH

				
			
Questa API richiede l’autenticazione tramite shopId e header X-Auth-Token. Per accedere a questo endpoint è necessario aver inviato con successo i documenti del cliente.
ParametroObbligatorioTipoFormatoDescrizione
documentOfTypeStringaTipo di documento. Valori consentiti: identity_carddriving_licensepassport
documentCodeStringaNumero del documento
documentCityStringaCittà in cui il documento è stato emesso
documentIssueDateStringaYYYY-MM-DDData di emissione del documento
documentExpirationDate  StringaYYYY-MM-DDData di scadenza del documento
ibanStringaIban
politicallyExposedBooleanoSpecifica se l’utente è una Persona Politicamente Esposta (PPE)
usPersonBooleanoSpecifica se l’utente è un cittadino statunitense
marketingBooleanoSpecifica se l’utente gradisce ricevere informazioni su offerte commerciali e novità da parte di Soisy
professionNoStringaProfessione dell’utente
L’API restituisce un oggetto JSON contenente i valori appena immessi.
CodiceDescrizione
200Richiesta completata con successo
400Errore di sintassi o di dominio
403Impossibile autenticare la richiesta
500Errore di sistema
				
					{
    "documentOfType": "identity_card",
    "documentCode": "AR123456",
    "documentCity": "Milano",
    "documentIssueDate": "2010-04-23",
    "documentExpirationDate": "2020-04-22",
    "iban": "IT60X0542811101000000123456",
    "politicallyExposed": false,
    "usPerson": false,
    "marketing": true,
    "profession": "carpenter",
    "paymentDayOfMonth": 15,
}
				
			

L’oggetto JSON restituito in caso di errore varia a seconda del codice HTTP di risposta.

Le risposte con questo codice HTTP indicano un errore lato client. La richiesta inviata conteneva un parametro formalmente errato.

				
					 {
     "errors": {
         {parametro}: [
             {messaggio}
         ]
      }
 }
				
			
Di seguito sono elencati gli errori possibili:
ParametroMessaggio
documentOfTypeQuesto valore non dovrebbe essere vuoto.
documentCodeQuesto valore non dovrebbe essere vuoto.
documentCityQuesto valore non dovrebbe essere vuoto.
documentIssueDateQuesto valore non è una data valida.
documentExpirationDate  Questo valore non è una data valida.
ibanQuesto valore non è un IBAN (International Bank Account Number) valido.
politicallyExposedQuesto valore non dovrebbe essere nullo.
usPersonQuesto valore non dovrebbe essere nullo.
marketingQuesto valore non dovrebbe essere nullo.
La richiesta inviata contiene delle credenziali non valide. Controlla lo shopId e l’header X-Auth-Token. Trovi maggiori info sulle credenziali nel paragrafo dell’autenticazione.
				
					 {
     "error": "Access denied"
 }
				
			

Le risposte con questo codice HTTP indicano che si è verificato un errore di sistema.

				
					{
    "errors": {
        "system": [
            "System error"
        ]
    }
}
				
			

Ciao!

Siamo on line dal lunedì al venerdì dalle 9.30 alle 12.30 e dalle 14.30 alle 17.30

Scrivici in questi orari, grazie!