Why the ^ symbol is displayed in text field values

Description

Sometimes you may notice that the output from Document Reader SDK or Web API includes the ^ symbol in some field values.

The ^ symbol is intentionally used by the SDK to indicate that the field value is split across multiple lines. This behavior typically appears in fields such as the address or issuing authority name when the original document contains multi-line text.

Example

1. Open the Regula Web API Demo.
2. Go to the Sample documents section.

3. Select the Germany Driving License document.

   

4. In this document, the Issuing authority field contains two lines.

   

5. Click the Process button.
6. Open the Response tab and find the Text fields block.

7. You will see the value LANDRATSAMT^MUSTERHAUSEN AM SEE.

   

   The ^ indicates that the original value was printed on two lines.

8. Switch to the Results tab and locate the Issuing authority field. You will see that the value is correctly displayed across two lines.