PensionSync
developer portal

Run your requests

1. Upload a PAPDIS or PASS document

$ curl -v https://api.pensionsync.com/api/pass/v1.0/upload/
{destinationId}?documentId={documentId}


Request 
> Method: POST / HTTP/1.1
> User-Agent: curl/7.27.0
> Host: https://api.pensionsync.com
> Path: /api/pass/v1.0/upload/{destinationId}?documentId={documentId}
> Content-Type: application/xml; charset=utf-8
> Query: documentId={documentId}
>
Response 
< HTTP/1.1 200 OK
< Connection: close
< Content-Type: application/xml, application/json; charset=utf-8
< Content: Job { JobId (string), Status (string) = ['NotStarted' or 'Running' or 'Completed' or 'Errored' or 'ValidationError' or 'DeliveryError'], PercentCompletion (integer, optional), Data (string, optional), Stage (string, optional) = ['Validation' or 'Delivery'] }

2. Monitor the Job

$ curl -v https://api.pensionsync.com/api/job/{jobId}


Request 
> Method: GET / HTTP/1.1
> User-Agent: curl/7.27.0
> Host: https://api.pensionsync.com
> Path: /api/job/{jobId}
>
>
Response 
< HTTP/1.1 200 OK
< Connection: close
< Content-Type: application/xml, application/json; charset=utf-8
< Content: Job { JobId (string), Status (string) = ['NotStarted' or 'Running' or 'Completed' or 'Errored' or 'ValidationError' or 'DeliveryError'], PercentCompletion (integer, optional), Data (string, optional), Stage (string, optional) = ['Validation' or 'Delivery'] }

3. Get Error Report

$ curl -v https://api.pensionsync.com/api/job/error/{jobId}


Request 
> Method: GET / HTTP/1.1
> User-Agent: curl/7.27.0
> Host: https://api.pensionsync.com
> Path: /api/job/error/{jobId}
>
>
Response 
< HTTP/1.1 200 OK
< Connection: close
< Content-Type: application/xml, application/json; charset=utf-8
< Content: ErrorReport {JobId (string), ProcessingError (string, optional) = ['InternalServerError'], SchemaErrors (array[SchemaValidationError], optional), JobResults (array[JobResult], optional) }