Créer une transaction

Les transactions sont la principale ressource de la vérification d’identité OneSpan (voir aussi Transaction model). Cette API crée et démarre l’exécution d’une nouvelle transaction :

• Créez des transactions avec des documents, des signatures, des signataires et une instance du flux de travail prédéfini.

• Créez des transactions avec des modèles de documents prédéfinis.

• Créez des transactions en fournissant des métadonnées supplémentaires qui seront conservées à titre de preuve électronique.

• Créez des transactions avec une instance d’un flux de travail prédéfini pour demander des vérifications de validation d’identité à exécuter via la vérification d’identité OneSpan.

• Créez des transactions qui nécessitent le consentement implicite ou explicite de l’utilisateur. Pour obtenir un exemple de demande, reportez-vous à la Example request with explicit consent. Pour la configuration du consentement, reportez-vous à la Transaction model.

Le nombre d’accords ne peut pas dépasser une taille totale de 50 Mo, et la taille d’un seul accord ne doit pas dépasser 10 Mo.

Syntaxe

PUT /api/transaction/

Exemples

Exemples de demandes

PUT api/transaction/ HTTP/1.1
Host: onespan.com
Accept: application/json, text/javascript
 
{
  "tenant_id":"5e52d7b8-8b18-41a4-9187-d4ce75af6815",
  "workflow_id":"80b601c9-f102-4761-9eaa-90ba8fcb58b6",
  "urlSetKey":"default",
  "brand_id":"a089f718-f12d-4b13-b82e-e1d8b324337d",
  "language": "english",
  "opaque_id": "WorkflowExternalMitAtPwd=1234",
  "configuration": {
    "redirects": [
      {
        "id": "REDIRECT_DOCID_PASS",
        "url": "https://www.overriddenUrl.com/?user={{userRole}}&transaction={{transactionId}}&opaqueId={{opaqueId}}"
      }
    ]
  },
  "users"[...],
  "documents"[...]
}

Exemple de demande avec consentement explicite

PUT api/transaction/ HTTP/1.1
Host: onespan.com
Accept: application/json, text/javascript
 
{
  "tenant_id":"5e52d7b8-8b18-41a4-9187-d4ce75af6815",
  "workflow_id":"80b601c9-f102-4761-9eaa-90ba8fcb58b6",
  "urlSetKey":"default",
  "brand_id":"a089f718-f12d-4b13-b82e-e1d8b324337d",
  "language": "english",
  "opaque_id": "WorkflowExternalMitAtPwd=1234",
  "configuration": {
    "redirects": [
      {
        "id": "REDIRECT_DOCID_PASS",
        "url": "https://www.overriddenUrl.com/?user={{userRole}}&transaction={{transactionId}}&opaqueId={{opaqueId}}"
      },
      "consent": {
        "explicit": true,
        "text": "I agree to the <URL link=\"myTermsURL"\> Terms and Conditions</URL> consent."
      }
    ]
  },
  "users"[...],
  "documents"[...]
}

Exemple de réponse

HTTP/1.1 200 OK

Vary: Accept
Content-Type: application/json
{
  "id":"dcaad720-d1e9-47ba-a76b-a6370ef0373b",

  "status":"new",
  "created":"2017-04-23T18:25:43.511Z",
  "tokens": [...],
  ...

}

En-têtes

Les en-têtes suivants sont inclus dans la demande et la réponse :

En-têtes de requête

• Accepter : le type de contenu de la réponse dépend de l’en-tête Accepter .

• Autorisation : jeton OAuth/JWT à authentifier.

En-têtes de réponse

• Type de contenu : application/json

Codes d’état