Skip to main content

Test onboarding in the sandbox

The sandbox is Nodu's test environment. Onboarding uses the same requests and the same statuses there as in production. In the sandbox, you choose the outcome of the review in one of two ways:

  • An address marker. You put a marker word in the second line of the customer's address. This works for individuals and businesses, in hosted onboarding and in API onboarding.
  • Test documents. You provide a test document that produces a fixed outcome. Use them when you test how your integration uploads documents and handles a rejected document.

Respondent onboarding follows your agreed checks and is outside these flows.

The outcomes​

Each way produces the same three outcomes:

OutcomeverificationStatusEvent
Approvalapprovedv1.customer.verification_approved
A request for more informationresubmission_requiredv1.customer.verification_resubmission_required
A final rejectionpermanently_rejectedv1.customer.verification_permanently_rejected

After an approval, the customer's status becomes active if the customer has also accepted Nodu's Terms of Service. How onboarding works, and customer statuses explains every status.

Before you start​

  • Use a sandbox API key. Send every request of these tests to the sandbox: see Environments and API keys.
  • Create a new customer for each outcome that you test. After a final rejection, you cannot submit the customer's application again.

Choose the outcome with an address marker​

When the sandbox reviews an application, it reads the second line of the customer's address. A marker in that line chooses the outcome:

The second address line containsOutcomerejection.message of the application
SIM-RESUBMITA request for more informationSandbox simulation: resubmission requested by the address marker.
SIM-REJECTA final rejectionSandbox simulation: final rejection requested by the address marker.

To get an approval, leave the second address line without a marker.

These rules apply to a marker:

  • Write the marker as a word of its own. Upper and lower case both work, and the hyphen is part of the marker. Other text can come before or after it: Suite 2 SIM-RESUBMIT and apt. 5, sim-reject both contain a marker. SIM-RESUBMITTED does not.
  • One marker decides. If the line contains both markers, SIM-REJECT decides.
  • Documents are checked first. If the application also has documents, a document that produces a request for more information or a final rejection decides the outcome. Nodu then does not read the marker. To test a marker on an application with documents, provide test documents that produce approval.

Hosted onboarding​

With hosted onboarding, you take the place of the customer in a browser.

  1. Create the customer. Then accept the terms on Nodu's terms page. Follow steps 1 and 2 of Hosted onboarding.
  2. Call Retrieve a link to verification page for a customer. Open the returned link.
  3. Fill in the page with test data. In the Address line 2 field, type the marker, for example Suite 2 SIM-RESUBMIT. When the page asks for a document, upload a test document that produces approval. Complete the other steps of the page.
  4. Call Retrieve a customer. Read verificationStatus in the response.

API onboarding​

  1. Create the customer with an application: follow steps 1 and 2 of Onboard a customer through the API. Put the marker in addressLine2 of the address: application.individual.address.addressLine2 for an individual, application.business.address.addressLine2 for a business.
  2. Upload the documents that the application requires: see Upload and replace documents. For an individual's identity documents and proof of address, use test documents that produce approval, so that the document checks do not decide before the marker. If the application needs no documents, continue to step 3.
  3. Call Submit an application for evaluation.
  4. Read the customer's verificationStatus and the application's status.

For example, this address in the create request produces a request for more information:

"address": {
"country": "PL",
"city": "Warszawa",
"state": "mazowieckie",
"addressLine1": "ul. Marszalkowska 1",
"addressLine2": "apt. 5 SIM-RESUBMIT",
"postalCode": "00-001"
}

The marker decides the outcome of the review only. The submit request still checks that the application is complete. A validation_failed response names what is missing.

Continue after a request for more information​

The marker stays in the address until you remove it. If you submit again with SIM-RESUBMIT still in the second address line, the review asks for more information again. To test an approval of the resubmission, remove the marker:

  • Hosted onboarding. Request a new verification link and open it. The page asks the customer to resubmit the personal information, or the company details for a business. Remove the marker from Address line 2. Then submit the page.
  • API onboarding. Call Update application data with the complete application data and addressLine2 without the marker. Data that you leave out of the update is removed from the application. Then submit the application again.

Resubmission and rejection describes these steps in full.

Choose the outcome with test documents​

Sumsub, the verification service that Nodu uses, publishes test documents for its sandbox. Each test document is a template: a file that produces one fixed outcome when you provide it as a verification document.

  • Get the templates. Download them from Sumsub's verification document templates page. The page says which outcome each template produces. The templates represent an individual's identity documents and proofs of address.
  • Keep the files unchanged. Use a template exactly as you downloaded it. Do not convert, crop or compress the file. A file that you changed does not work as a template.

Hosted onboarding with test documents​

  1. Create the customer. Then accept the terms on Nodu's terms page. Follow steps 1 and 2 of Hosted onboarding.
  2. Call Retrieve a link to verification page for a customer. Open the returned link.
  3. When the page asks for a document, upload the template for the outcome that you want. Complete the other steps of the page.
  4. Call Retrieve a customer. Read verificationStatus in the response.

To continue after a request for more information, request a new verification link. Open the returned link. Then upload a template that produces approval. Resubmission and rejection describes these steps.

API onboarding with test documents​

With API onboarding, upload the template to the application.

  1. Create the customer with an application: follow steps 1 and 2 of Onboard a customer through the API.
  2. Call Upload an application document with the template as the file. Send the kind of the document that the template shows. For example, for an identity card template, send kind=identity and subType=id_card. Upload each side in a separate request. Upload a document explains the fields.
  3. Call Submit an application for evaluation.
  4. Read the customer's verificationStatus and the application's status.

For example, this request uploads the front of an identity card template that you saved as id-card-front.jpg. Set country to the country that the template shows:

curl 'https://api.sandbox.nodu.fi/v1/customers/<customer-id>/applications/<application-id>/documents' \
--header 'Authorization: Bearer <your-api-key>' \
--form kind=identity \
--form subType=id_card \
--form side=front \
--form country=<country-code> \
--form file=@id-card-front.jpg

The template decides the outcome of the review only. The submit request still checks that the application is complete. A validation_failed response names what is missing.

To continue after a request for more information, replace the document with a template that produces approval: see Replace a document. Then submit the application again, as Resubmission and rejection describes.

Reuse verification with Sumsub sharing​

A test of onboarding with Sumsub sharing needs more preparation. You need a client ID for the sandbox from Nodu. Sharing a test applicant can also require additional agreements. Ask Nodu before you build this test.

Business customers and other statuses​

Use the address marker to produce each outcome for a business customer. The test documents exercise an individual's document verification. Verify the agreed company documents and the submission flow separately. Build the handling of a business customer's final rejection from Final rejection.

To handle the statuses suspended and blocked in your integration, follow the steps in Suspended and blocked customers.

Next steps​