Passer au contenu

Get disposable contract

Requête

Returns the disposable contract (Mod_NAMCA22D), the privacy document URL, and the T&C document URL for the specified LRA.

The contract is pre-filled with holder data if disposableHolder, disposableContacts and disposableDoc are all provided. If omitted, the contract is returned blank.

Sécurité
basicAuth and sslCertificate
Chemin
lraIdstringobligatoire

Local Registration Authority (LRA) identifier.

Corpsapplication/jsonobligatoire
languageCodeArray of stringsobligatoire

Languages of the document. ISO 639-1 alpha-2 codes. You can specify more than one value.

Exemple:
[ "IT" ]
docTypesArray of integers, (int32)obligatoire

Type of document to return. 1 = PDF, 2 = TXT. You can specify more than one value.

Exemple:
[ 1, 2 ]
productTypestringobligatoire

Type of disposable certificate. See DisposableType.

Exemple:"DISPOSABLE"
countrystring

Country where the end user is located. ISO 3166-1 alpha-2 code. Optional — if not specified, the default template for the given languageCode is returned. Required when a LRA needs contracts in the same language but for different legislations (e.g. French contract for France vs Belgium).

Exemple:"IT"
disposableHolderobject(DisposableHolder)

Holder data. Optional — if provided together with disposableContacts and disposableDoc, the contract (Mod_NAMCA22D) is pre-filled.

disposableContactsobject(DisposableContacts)

Holder contact information. Required if otpType=SMS or otpType=EMAIL. Provide mobile if otpType=SMS, email if otpType=EMAIL.

disposableDocobject(DisposableDoc)

Identity document information.

Not required if one of the following conditions is true:

  • DisposableIdentification.identificationType is AML
  • DisposableHolder.identificationType is one of: PASSPORT, PERSONAL_NUMBER, NATIONAL_IDENTITY_CARD, DRIVING_LICENSE, RESIDENCE_PERMIT, RESIDENCE_PERMIT_TEMP, EMBASSY_DOCUMENT
disposableCertificateobject(DisposableCertificate)

Disposable Certificate configuration.

curl -i -X POST \
  -u '<username>:<password>' \
  'https://lean.namirialtsp.com/RAWS_DISPOSABLE/api/document/{lraId}/getDisposableContract' \
  -H 'Content-Type: application/json' \
  -d '{
    "languageCode": [
      "EN"
    ],
    "docTypes": [
      1
    ],
    "productType": "DISPOSABLE"
  }'

Réponses

OK

Corpsapplication/json
Array [
languageCodestring

Language of the document. ISO 639-1 alpha-2 code.

Exemple:"IT"
docTypesinteger, (int32)

Document type. 1 = PDF, 2 = TXT.

Exemple:2
docstring, (binary)

Base64-encoded document (Mod_NAMCA22D). Pre-filled with holder data if disposableHolder, disposableContacts and disposableDoc were provided in the request.

checkBoxesArray of strings

List of checkbox label strings to be displayed to the user for acceptance.

]
Réponse
[ { "languageCode": "EN", "docTypes": 1, "doc": "<base64-encoded PDF>", "privacy_link": "https://docs.namirialtsp.com/documents/Mod_NAM_GDPR03D_ENG_IT.pdf", "termsAndConditions_link": "https://docs.namirialtsp.com/documents/Mod_NAM_CA01D_ENG_IT.pdf", "checkBoxes": [ … ] } ]