Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README with the new onfido version #141

Merged
merged 2 commits into from
Aug 29, 2024

Conversation

pnodet
Copy link
Contributor

@pnodet pnodet commented Aug 29, 2024

Documentation has not been updated since v3. The file upload example needs to be updated.

Also, the types indicates that we can pass a LocationBuilder but doing so results in error: source.on is not a function

await onfidoClient
        .uploadDocument(
          type,
          applicantId,
          new FileTransfer(Buffer.from(document.buffer), document.originalname),
          document.mimetype as UploadDocumentFileTypeEnum,
          side,
          'FRA',
          false,
          { country_of_residence: 'FRA' },
        )

Maybe the file downloads documentation should be updated too.

README.md Outdated Show resolved Hide resolved
Co-authored-by: dvacca-onfido <[email protected]>
@pnodet pnodet requested a review from dvacca-onfido August 29, 2024 07:34
Copy link
Contributor

@dvacca-onfido dvacca-onfido left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @pnodet for your contribution.

I've made the change permanent as part of PR: onfido/onfido-openapi-spec#113
That PR is also going to include an improved download section.

I'll be back to you regarding the issue you raised regarding the location parameter.

@dvacca-onfido
Copy link
Contributor

@pnodet we've delivered version v3.5.0 which should solve the issue with document upload with location you've raised.

@pnodet
Copy link
Contributor Author

pnodet commented Sep 6, 2024

Thanks a lot, will check!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants