Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,7 @@ This site uses the [U.S. Web Design Standards](https://standards.usa.gov). To up
2. Copy contents to `assets/`
3. Rename directory to `uswds`
4. Download latest [anchor.js](https://github.com/bryanbraun/anchorjs) and put in `assets/js/`

#### YAML files

When updating a `yml` file, you only need to update the version in the `/assets` directory. This is symlinked to the `_includes` directory.
8 changes: 6 additions & 2 deletions _pages/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@ Login.gov prompts users to upload the front and back of their documents during p

#### Data testing

A YAML file can be uploaded instead of a State ID image to trigger different behaviors. You will upload this text file for the front and back for the State ID. The YAML file can be used to simulate the reading of certain attributes from the State ID. Here is an example YAML file that does that:
⚠️ Only the YAML file in the `back` upload box is used on submission. For that reason, it's good practice to upload the same yaml file in all three upload boxes to avoid confusion when testing.

A YAML file can be uploaded instead of a State ID image to trigger different behaviors. You will upload the same YAML file for the front and back of the State ID, and also the selfie (if that field appears). Different YAML files can be used to simulate the reading of certain attributes from the State ID or selfie. Here is an example YAML file that does that:

{% include yaml_download.md filename="proofing.yml" %}

Expand Down Expand Up @@ -136,7 +138,9 @@ Alert names with attention or failed values show under `failed_alerts`. Only pas
- name: Visible Photo Characteristics
```

**NOTE:** Even if you put all passing information into the test yaml file it will still produce an error. There are configurations of the above yaml file that cannot happen in real vendor responses. It is possible there will be unexpected outcomes in those cases.
**NOTES:**

- There are configurations of the above yaml file that cannot happen in real vendor responses. It is possible there will be unexpected outcomes in those cases.

### Personal information verification

Expand Down
4 changes: 3 additions & 1 deletion assets/yaml/sample_full_error.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,6 @@ failed_alerts:
passed_alerts:
- name: Visible Pattern
result: Passed
liveness_result: Fail # values: Pass, Fail
portrait_match_results:
FaceMatchResult: Pass # returns the portrait match result - values: Pass, Fail
FaceErrorMessage: 'Successful. Liveness: Live' # returns the liveness result - values: 'Successful. Liveness: Live', 'Liveness: NotLive', 'Liveness: PoorQuality'